POST api/Lead
Request Information
URI Parameters
None.
Body Parameters
LeadPackageName | Description | Type | Additional information |
---|---|---|---|
LeadObj | Lead |
None. |
|
ListId | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "LeadObj": { "LeadId": "sample string 1", "PortalCustomerId": "sample string 2", "ProspectType": "sample string 3", "AssetTrackId": "sample string 4", "CampaignId": "sample string 5", "AssetURLId": "sample string 6", "AssetURLRotationId": "sample string 7", "Id": "sample string 8", "CampaignMemberId": "sample string 9", "FirstName": "sample string 10", "LastName": "sample string 11", "Email": "sample string 12", "CompanyName": "sample string 13", "Phone": "sample string 14", "PushCode": "sample string 15", "CreatedById": "sample string 16", "CreatedDate": "2025-05-13T14:04:47.0701485+00:00", "UpdatedById": "sample string 18", "UpdatedDate": "2025-05-13T14:04:47.0701485+00:00", "_LeadSource": "sample string 20", "LeadSource": "sample string 21", "Address1": "sample string 22", "Address2": "sample string 23", "City": "sample string 24", "State": "sample string 25", "PostalCode": "sample string 26", "Country": "sample string 27", "OwnerId": "sample string 28", "CRMOwnerId": "sample string 29", "Notification": 30, "Validation": 31, "Title": "sample string 32", "EngageScore": 33, "CRMAccountId": 34, "_CustomData": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "LeadCustom": "sample string 35", "CustomDataContact": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "ContactCustom": "sample string 36", "CustomData": "sample string 37" }, "ListId": "sample string 1" }
application/xml, text/xml
Sample:
<LeadPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage"> <LeadObj> <Address1>sample string 22</Address1> <Address2>sample string 23</Address2> <AssetTrackId>sample string 4</AssetTrackId> <AssetURLId>sample string 6</AssetURLId> <AssetURLRotationId>sample string 7</AssetURLRotationId> <CRMAccountId>34</CRMAccountId> <CRMOwnerId>sample string 29</CRMOwnerId> <CampaignId>sample string 5</CampaignId> <CampaignMemberId>sample string 9</CampaignMemberId> <City>sample string 24</City> <CompanyName>sample string 13</CompanyName> <ContactCustom>sample string 36</ContactCustom> <Country>sample string 27</Country> <CreatedById>sample string 16</CreatedById> <CreatedDate>2025-05-13T14:04:47.0701485+00:00</CreatedDate> <CustomData>sample string 37</CustomData> <CustomDataContact xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </CustomDataContact> <Email>sample string 12</Email> <EngageScore>33</EngageScore> <FirstName>sample string 10</FirstName> <Id>sample string 8</Id> <LastName>sample string 11</LastName> <LeadCustom>sample string 35</LeadCustom> <LeadId>sample string 1</LeadId> <LeadSource>sample string 21</LeadSource> <Notification>30</Notification> <OwnerId>sample string 28</OwnerId> <Phone>sample string 14</Phone> <PortalCustomerId>sample string 2</PortalCustomerId> <PostalCode>sample string 26</PostalCode> <ProspectType>sample string 3</ProspectType> <PushCode>sample string 15</PushCode> <State>sample string 25</State> <Title>sample string 32</Title> <UpdatedById>sample string 18</UpdatedById> <UpdatedDate>2025-05-13T14:04:47.0701485+00:00</UpdatedDate> <Validation>31</Validation> <_CustomData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </_CustomData> <_LeadSource>sample string 20</_LeadSource> </LeadObj> <ListId>sample string 1</ListId> </LeadPackage>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RestAPIResponseName | Description | Type | Additional information |
---|---|---|---|
statusCode | integer |
None. |
|
status | string |
None. |
|
message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "statusCode": 1, "status": "sample string 2", "message": "sample string 3" }
application/xml, text/xml
Sample:
<RestAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage"> <message>sample string 3</message> <status>sample string 2</status> <statusCode>1</statusCode> </RestAPIResponse>