1100: Create lead
leadSourceID
 and all fields are configured within the Rubiq Lead Management app.Endpoint ID: | 1100 | ||
Method | POST | ||
URL: | /entity/lead/{leadSourceID} | ||
leadSourceID | A GUID identifying the type of Lead to create | ||
Request body: | JSON data with properties corresponding to the fields in the specified Lead type
{ "keys": { "email": "mailbox@mailserver.com", "mobile": "123 456 789" }, "data": { "name": "John Doe", "address": "1 Harbour Tce., Townsville" }, "context": { "pageUrl": "https://domain.org/lead/generation", "campaignID": "f3ff7b9a-c57c-409b-8d6a-8d6c44640f0e" } } | ||
Response body: | The Rubiq ID of the newly created lead entity is returned, unless the lead source has been configured to not create entities, in which case an empty JSON block { "id": 12345 } | ||
Status codes: | HttpStatusCode | ApiStatusSubCode | Description |
200 | Lead created | ||
400 | Request is valid but data validation failed | ||
400.1 | Inactive leadSourceID | ||
400.3 | Required keys field missing | ||
400.4 | Required data field missing | ||
400.5 | Required context field missing | ||
404 | 404.4 |
|