POST api/Lead/AddReferralLeads

Request Information

URI Parameters

None.

Body Parameters

Collection of ReferralLeadDTO

Name	Type	Additional information
OriginId	integer	None.
LeadId	integer	None.
FirstName	string	None.
MiddleInitial	string	None.
LastName	string	None.
Zip	string	None.
Address	string	None.
Address2	string	None.
PrimaryPhone	string	None.
PrimaryEmail	string	None.
SecondaryPhone	string	None.
BankTypeId	integer	None.
CityId	integer	None.
StateId	integer	None.
CountryId	integer	None.
OfficeId	integer	None.
DateOfBirth	date	None.
Age	integer	None.
AgeOption	integer	None.
GeoAddress	string	None.
Lat	decimal number	None.
Long	decimal number	None.
GeoCodeStatus	GeoCodeStatusEnum	None.
IsGeoCodeAttempted	boolean	None.
GroupId	integer	None.
ReferredBy	string	None.
Organization	string	None.
RelationShip	string	None.
LocationCode	string	None.
Beneficiary	string	None.
FullName	string	None.
NumberOfChildren	integer	None.
Notes	string	None.
Occupation	string	None.
Spouse	string	None.
PacketId	string	None.
DateEntered	date	None.
CreateDate	date	None.
AssociateId	integer	None.
AssociateContractId	integer	None.
OldAssociateContractId	integer	None.
HasReferralImages	boolean	None.
LeadBankTypeId	integer	None.
CityName	string	None.
StateName	string	None.
CountryName	string	None.
NumberOfKits	integer	None.
BranchOfService	string	None.
OutOfArea	boolean	None.
LeadCityName	string	None.
LeadStateName	string	None.
IsStarred	boolean	None.
ApplicationFeatureId	integer	None.
IsLookingForCareerUpdate	boolean	None.
TimezoneId	integer	None.
TimezoneOffset	decimal number	None.
TimezoneCode	string	None.
PresentationId	integer	None.
DroppedPin	boolean	None.
IsPrimaryDNC	boolean	None.
IsSecondaryDNC	boolean	None.
LocationContextCode	string	None.
LeadStatusTypeId	integer	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "OriginId": 4,
    "LeadId": 1,
    "FirstName": "sample string 2",
    "MiddleInitial": "sample string 3",
    "LastName": "sample string 4",
    "Zip": "sample string 5",
    "Address": "sample string 6",
    "Address2": "sample string 7",
    "PrimaryPhone": "sample string 8",
    "PrimaryEmail": "sample string 9",
    "SecondaryPhone": "sample string 10",
    "BankTypeId": 1,
    "CityId": 1,
    "StateId": 1,
    "CountryId": 1,
    "OfficeId": 1,
    "DateOfBirth": "2025-10-14T05:07:16.4989147-07:00",
    "Age": 1,
    "AgeOption": 1,
    "GeoAddress": "sample string 11",
    "Lat": 12.1,
    "Long": 13.1,
    "GeoCodeStatus": 1,
    "IsGeoCodeAttempted": true,
    "GroupId": 1,
    "ReferredBy": "sample string 14",
    "Organization": "sample string 15",
    "RelationShip": "sample string 16",
    "LocationCode": "sample string 17",
    "Beneficiary": "sample string 18",
    "FullName": "sample string 4, sample string 2",
    "NumberOfChildren": 19,
    "Notes": "sample string 20",
    "Occupation": "sample string 21",
    "Spouse": "sample string 22",
    "PacketId": "sample string 23",
    "DateEntered": "2025-10-14T05:07:16.4989147-07:00",
    "CreateDate": "2025-10-14T05:07:16.4989147-07:00",
    "AssociateId": 26,
    "AssociateContractId": 27,
    "OldAssociateContractId": 28,
    "HasReferralImages": true,
    "LeadBankTypeId": 1,
    "CityName": "sample string 29",
    "StateName": "sample string 30",
    "CountryName": "sample string 31",
    "NumberOfKits": 32,
    "BranchOfService": "sample string 33",
    "OutOfArea": true,
    "LeadCityName": "sample string 34",
    "LeadStateName": "sample string 35",
    "IsStarred": true,
    "ApplicationFeatureId": 36,
    "IsLookingForCareerUpdate": true,
    "TimezoneId": 1,
    "TimezoneOffset": 38.0,
    "TimezoneCode": "sample string 39",
    "PresentationId": 40,
    "DroppedPin": true,
    "IsPrimaryDNC": true,
    "IsSecondaryDNC": true,
    "LocationContextCode": "sample string 44",
    "LeadStatusTypeId": 1
  },
  {
    "OriginId": 4,
    "LeadId": 1,
    "FirstName": "sample string 2",
    "MiddleInitial": "sample string 3",
    "LastName": "sample string 4",
    "Zip": "sample string 5",
    "Address": "sample string 6",
    "Address2": "sample string 7",
    "PrimaryPhone": "sample string 8",
    "PrimaryEmail": "sample string 9",
    "SecondaryPhone": "sample string 10",
    "BankTypeId": 1,
    "CityId": 1,
    "StateId": 1,
    "CountryId": 1,
    "OfficeId": 1,
    "DateOfBirth": "2025-10-14T05:07:16.4989147-07:00",
    "Age": 1,
    "AgeOption": 1,
    "GeoAddress": "sample string 11",
    "Lat": 12.1,
    "Long": 13.1,
    "GeoCodeStatus": 1,
    "IsGeoCodeAttempted": true,
    "GroupId": 1,
    "ReferredBy": "sample string 14",
    "Organization": "sample string 15",
    "RelationShip": "sample string 16",
    "LocationCode": "sample string 17",
    "Beneficiary": "sample string 18",
    "FullName": "sample string 4, sample string 2",
    "NumberOfChildren": 19,
    "Notes": "sample string 20",
    "Occupation": "sample string 21",
    "Spouse": "sample string 22",
    "PacketId": "sample string 23",
    "DateEntered": "2025-10-14T05:07:16.4989147-07:00",
    "CreateDate": "2025-10-14T05:07:16.4989147-07:00",
    "AssociateId": 26,
    "AssociateContractId": 27,
    "OldAssociateContractId": 28,
    "HasReferralImages": true,
    "LeadBankTypeId": 1,
    "CityName": "sample string 29",
    "StateName": "sample string 30",
    "CountryName": "sample string 31",
    "NumberOfKits": 32,
    "BranchOfService": "sample string 33",
    "OutOfArea": true,
    "LeadCityName": "sample string 34",
    "LeadStateName": "sample string 35",
    "IsStarred": true,
    "ApplicationFeatureId": 36,
    "IsLookingForCareerUpdate": true,
    "TimezoneId": 1,
    "TimezoneOffset": 38.0,
    "TimezoneCode": "sample string 39",
    "PresentationId": 40,
    "DroppedPin": true,
    "IsPrimaryDNC": true,
    "IsSecondaryDNC": true,
    "LocationContextCode": "sample string 44",
    "LeadStatusTypeId": 1
  }
]

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LeadSaveDetailWithSummary

Name	Type	Additional information
lstLeadSaveDetail	Collection of LeadSaveDetail	None.
LeadTransferGeneralAvailabiltyMsg	string	None.
LeadAssignToYouMsg	string	None.
LeadAssignToUplineHierarchyMsg	string	None.
LeadAssignToInDifferentContextMsg	string	None.

Response Formats

application/json, text/json

Sample:

{
  "LeadTransferGeneralAvailabiltyMsg": "sample string 1",
  "LeadAssignToYouMsg": "sample string 2",
  "LeadAssignToUplineHierarchyMsg": "sample string 3",
  "LeadAssignToInDifferentContextMsg": "sample string 4",
  "lstLeadSaveDetail": [
    {
      "LeadId": 1,
      "PacketId": "sample string 2",
      "AssociateId": 1,
      "AssociateContractId": 1,
      "IsAssignedInUplineHierarchy": true
    },
    {
      "LeadId": 1,
      "PacketId": "sample string 2",
      "AssociateId": 1,
      "AssociateContractId": 1,
      "IsAssignedInUplineHierarchy": true
    }
  ]
}