Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Endpoint ID:

1100

Method
Status
colourGreen
titlePOST
URL:

/user/{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. pageUrlticketpopupNamepartnerNameemployeeName, ...

Code Block
Example 1 - Contract specifies full name, email and password:
titlelanguagejs
{
	"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"
    }
}



Span
stylewhite-space:pre
Response body:


JSON data with key for the newly created or updated Lead including the lead data.

Code Block
Example 1 – App setting specifies no specific key:
titlelanguagejs
{
	"entityID": 123456,
	"keys": {
        "email": "mailbox@mailserver.com",
        "mobile": "123 456 789"
    },
	"data": {
        "name": "John Doe",
        "address": "1 Harbour Tce., Townsville"
    }
}


Status codes:200

A Lead already exists with matching keys - the Lead data was updated.


201Lead created

400

Request is valid but data validation failedIn case SMS verification is enabled, the following sub codes may be returned:

400.3Required keys field missing
400.4Required data field missing


...