NAV

Create a Lead via API

Use the endpoints to emulate sending traffic or Lead registration via API integration.

Request example

URL, method: POST https://integration.{brand name}.clixnow.com/api/system/v1/leads

Header: Authorization: ApiToken {unique API Token provided to the Affiliate}

Content-Type: application/json

Example Request:

curl --location --globoff 'https://integration.{brand name}.clixnow.com/api/system/v1/leads' \
--header 'Content-Type: application/json' \
--header 'Authorization: ApiToken {unique API Token provided to the Affiliate}' \
--data '{BODY_DATA}'

Body:

Copy the body example below the CURL request instead of {BODY_DATA} placeholder.

{
   "firstName":"Allison",
   "lastName":"Brown",
   "email":"[email protected]",
   "phone":"+41123456789",
   "countryCode":"CH",
   "referralUrl":"https://website.com",
   "subcampaign":"subcampaign",
   "keyword":"test",
   "placement":"landing_page",
   "clickId":"20fn4ngo56n3snf74",
   "ipAddress":"1.1.1.1",
   "languageCode":"EN",
   "password":"Password123!",
   "sub2":"sub2",
   "deviceType":"Mobile",
   "deviceName":"iPhone16",
   "osName":"iOS",
   "browser":"Safari Mobile",
   "carrier":"Mobile"
}

Parameters

Name Type Mandatory Description
firstName string Yes Lead’s first name
lastName string Yes Lead’s last name
email string Yes Lead’s email address
phone string Yes Lead’s phone number
Password string Yes Lead’s password, a special character is required, min number of required characters is eight
countryCode string Yes Alpha-2 country code
languageCode string No* Alpha-2 country code *If Language Detection – Registration Language, then field is mandatory
acceptTermsAndConditions boolean No By default: false
acceptPromotions boolean No By default: false
referralUrl string No URL of the landing page. URL Example
subCampaign string No Identify sources or marketing campaigns. Can be sent in postback
placement string No Name of the landing page or ad. Can be sent in postback
keyword string No Keyword name. Can be sent in postback
sub2 string No Extra free sub value. Can be sent in postback
clickId string No Can be sent in postback
deviceType string No Device type
deviceName string No Device name
osName string No Operational system of the device
browser string No Browser on the device
carrier string No Possible values: Mobile, WiFi
ipAddress string No IPv4 or IPv6
comment string No Any text comment, up to 1000 characters

Landing page URL Example

https://landing.com/?a_id={Affiliate ID}\&c_id={Landing page ID}\&f_id={Related Funnel ID}\&subcampaign=subcampaign\&sub2=sub_name\&keyword=test\&clickid=1c33d66a941ac90a6\&placement=test

Response

The 200 OK response for the registered Lead will return:

{
"leadId": 123456,
"redirectUrl": "https:…",
"subCampaign": "subcampaign",
"placement": "placement",
"keyword": "keyword",
"sub2": "sub2",
"clickId": "clickId",
"crmId": "crmId"
}

Request and Response

An object that contains an error will be returned when API request fails. Error codes:

Status Description
200 OK General success status code
201 Created Item was created successfully via POST
400 Bad Request General error when fulfilling the request would cause an invalid state. Domain validation errors, missing data, etc.
401 Unauthorized Error code response for missing or invalid authentication token
403 Forbidden Error code for when the user is not authorized to perform the operation, or certain item is unavailable for some reason.
415 Unsupported Media Type Wrong Accept/Content-Type

Monitoring data

URL, method: GET https://integration.{brand name}.clixnow.com/api/system/v1/leads/search?

Header: Authorization: ApiToken {personal API Token}

Example Request:

curl --location --globoff 'https://integration.{brand name}.clixnow.com/api/system/v1/leads/search?createdOnFrom=2021-08-08T00%3A00%3A00&createdOnTo=2021-08-08T23%3A59%3A59'\
--header 'Authorization: ApiToken {YourApiToken}'

Use the parameters below to retrieve the necessary data:

Name Type Description
orderBy string Ability to sort ascendingly the returned Leads by: ModifiedOn, CreatedOn, FtdFate, Id – please make sure that the first letter in the name of the parameter is big. For now there is no ability to sort descendingly;
id integer Ability to get Lead details by lead Id in Clixnow
count integer Paging parameter - number of Leads to fetch; defaults to 10; !max number of records per request is 1000!
skip integer Paging parameter - number of Leads to skip from the beginning of list or from the previous group of fetched records; defaults to 0
modifiedOnFrom string (date-time) Start date of the date range to filter by update date and time (in UTC)
modifiedOnTo string (date-time) End date of the date range to filter by update date and time (in UTC)
createdOnFrom string (date-time) Start date of the date range to filter by creation date and time (in UTC)
createdOnTo string (date-time) End date of the date range to filter by creation date and time (in UTC)
ftdDateTo string (date-time) Start date of the date range to filter by FTD date and time (in UTC)
ftdDateFrom string (date-time) End date of the date range to filter by FTD date and time (in UTC)

Response model

Name Type Description
id integer ID of the Lead within Clixnow
email string Lead email, that value is sent over registration request
status string Lead status
crmId integer ID of the Lead in Brand CRM that accepted the Lead. Visibility is controlled per Affiliate via Admin UI.
brandId integer ID of the Brand in Clixnow; brand which accepted the Lead. Visibility is controlled per Affiliate via Admin UI.
brandName string Name of the Brand in Clixnow; brand which accepted the Lead
createdOn string (date-time) Date when the Lead was updated in UTC, ex. 2022-12-19T11:01:58.302Z
updatedOn string (date-time) Date when the Lead was updated in UTC, ex. 2022-12-19T11:01:58.302Z
ftdDate string (date-time) Returns FTD date if such was made. Visibility is controlled per Affiliate via Admin UI.
clickId integer The value that was sent in registration request
sub2 string The value that was sent in registration request
subCampaign string The value that was sent in registration request
keyword string The value that was sent in registration request
placement string The value that was sent in registration request
clientType string Can be Client (when FTD was made) or Depositor (when FTD was not made)

Pagination:

By default, the response includes 10 records. To retrieve more, use the count parameter (e.g., count=1000). If there are over 1000 records, use the ‘skip’ parameter to fetch subsequent batches.

Example:

https://integration.{brand name}.clixnow.com/api/system/v1/leads/search?createdOnFrom=2021-08-08T00:00:00&createdOnTo=2021-08-08T23:59:59&count=1000&skip=0

**Additional Filters:
**You can also filter by ‘modifiedOn’ or ‘ftdDate’ using similar date and time formats. Specify the required parameter in the query.

Errors

Text Description automatically generated

Shape, rectangle Description automatically generated

Integrations

Platforms