1101: Get lead source fields

Owned by Nick Jensen
Last updated: Apr 07, 2021Version comment
2 min read
Returns the required and optional fields used in Lead creation.
Endpoint ID:

1101

Method
GET
URL:

/entity/lead/{leadSourceID}


leadSourceID

A GUID identifying the type of Lead to create

Request body:

None

Response body:

The response contains 3 arrays: "keys", "data" and "context", containing the various types of fields available.

"keys" are always required, and always of type "text".

"data" and "context" fields may be required or optional as indicated by the "required" property. They also have an associated type, which is one of "text", "number", "date" and "boolean".

{
   "keys": [
      "email",
      "mobile"
   ],
   "data": [
      {
         "name": "name",
         "type": "text",
         "required": true
      },
      {
         "name": "address",
         "type": "text",
         "required": false
      }
   ],
   "context": [
      {
         "name": "pageUrl",
         "type": "text",
         "required": false
      },
      {
         "name": "campaignID",
         "type": "number",
         "required": true
      }
   ]
}
Status codes:

HttpStatusCode
ApiStatusSubCode
Description
200
Success
404404.4

leadSourceID not found