...
| Excerpt |
|---|
Creates a new Lead entity. The leadSourceID and all fields are configured within the Rubiq Lead Management app. |
| Endpoint ID: | 1100 |
| Method | |
| URL: | / |
userentity/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: Required. Uniquely identifiable keys for the lead, configured in the Rubiq Lead Management app.
data: Optional. Lead entity data fields, configured in the Rubiq Lead Management app. Note that this property is only optional as long as no required data fields have been configured.
context: Optional. Extra information about where this lead has come from, e.g. pageUrl, ticket, popupName, partnerName, employeeName, ...
|
title | Example 1 - Contract specifies full name, email and password: | {
"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"
}
} |
|
|
preJSON data with key for | The Rubiq ID of the newly created |
or updated Lead including the lead datalead entity is returned, unless the lead source has been configured to not create entities, in which case an empty JSON block { } is returned. |
title | Example 1 – App setting specifies no specific key:entityID123456,
"keys": {
"email": "mailbox@mailserver.com",
"mobile": "123 456 789"
},
"data": {
"name": "John Doe",
"address": "1 Harbour Tce., Townsville"
}
|
Status codes:
| HttpStatusCode |
200 | A Lead already exists with matching keys - the Lead data was updated. | 201ApiStatusSubCode | Description |
| 200 |
| Lead created |
| 400 |
| Request is valid but data validation failed |
In case SMS verification is enabled, the following sub codes may be returned: |
| 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 | leadSourceID not found
|