POST api/CRM

Request Information

URI Parameters

None.

Body Parameters

Lead

Name	Type	Additional information
LeadId	string	None.
PortalCustomerId	string	None.
ProspectType	string	None.
AssetTrackId	string	None.
CampaignId	string	None.
AssetURLId	string	None.
AssetURLRotationId	string	None.
Id	string	None.
CampaignMemberId	string	None.
FirstName	string	None.
LastName	string	None.
Email	string	None.
CompanyName	string	None.
Phone	string	None.
PushCode	string	None.
CreatedById	string	None.
CreatedDate	date	None.
UpdatedById	string	None.
UpdatedDate	date	None.
_LeadSource	string	None.
LeadSource	string	None.
Address1	string	None.
Address2	string	None.
City	string	None.
State	string	None.
PostalCode	string	None.
Country	string	None.
OwnerId	string	None.
CRMOwnerId	string	None.
Notification	integer	None.
Validation	integer	None.
Title	string	None.
EngageScore	integer	None.
CRMAccountId	integer	None.
_CustomData	Dictionary of string [key] and string [value]	None.
LeadCustom	string	None.
CustomDataContact	Dictionary of string [key] and string [value]	None.
ContactCustom	string	None.
CustomData	string	None.

Request Formats

application/json, text/json

Sample:

{
  "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-13T04:33:58.4288669+00:00",
  "UpdatedById": "sample string 18",
  "UpdatedDate": "2025-05-13T04:33:58.4288669+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"
}

application/xml, text/xml

Sample:

<Lead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <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-13T04:33:58.4288669+00:00</CreatedDate>
  <CustomData>sample string 37</CustomData>
  <CustomDataContact xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1: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-13T04:33:58.4288669+00:00</UpdatedDate>
  <Validation>31</Validation>
  <_CustomData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </_CustomData>
  <_LeadSource>sample string 20</_LeadSource>
</Lead>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseService

Name	Type	Additional information
validRequest	boolean	None.
RequestMessage	string	None.
EntityName	string	None.
EntityId	string	None.
URL	string	None.
APIVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "validRequest": true,
  "RequestMessage": "sample string 2",
  "EntityName": "sample string 3",
  "EntityId": "sample string 4",
  "URL": "sample string 5",
  "APIVersion": "sample string 6"
}

application/xml, text/xml

Sample:

<ResponseService xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <APIVersion>sample string 6</APIVersion>
  <EntityId>sample string 4</EntityId>
  <EntityName>sample string 3</EntityName>
  <RequestMessage>sample string 2</RequestMessage>
  <URL>sample string 5</URL>
  <validRequest>true</validRequest>
</ResponseService>