Login into system using operator. Creates a session token, to be used in all subsequent calls.
username | string | A valid username. | |
password | password | Password |
200 | Ok! operation done succesufully |
400 | general error |
401 | unauthorized |
404 | not found |
Logout from system and destroy the session token.
token | string | session token |
200 | Ok! operation done succesufully |
400 | general error |
404 | not found |
Add new lead with minimal data
token | string | session token | |
string | email address (required at least one) | ||
phone | string | phone number (required at least one) | |
fname | string | first name | |
lname | string | last name | |
gender | string | gender type (M or F) | |
birthday | string | birthday date (YYYY-MM-DD) | |
address | string | address | |
zipcode | string | zip code address | |
city | string | city address | |
province | string | province code address | |
country | string | country code address | |
leadcode | string | custom lead code | |
leadsource | string | custom source code | |
company | string | company name | |
vatcode | string | company vat code | |
fiscalcode | string | fiscal code | |
privacy | string | privacy accept (0/1) | |
privacydt | string | date privact accept (YYYY-MM-DD) | |
privacyip | string | ip address source privact accept | |
promoter | string | promoter name | |
subscribedt | string | subscribe date (YYYY-MM-DD) |
200 | Ok! operation done succesufully |
400 | general error |
404 | not found |
405 | missing data required |
Check exists lead entry by email address.
token | string | session token | |
string | email address |
200 | Ok! operation done succesufully |
400 | general error |
404 | not found |
405 | missing data required |
406 | item not valid (blacklisted) |
407 | item not valid (error-tag) |
Check exists lead entry by email address.
token | string | session token | |
phone | string | phone number (without internal space) |
200 | Ok! operation done succesufully |
400 | general error |
404 | not found |
405 | missing data required |
406 | item not valid (blacklisted) |
407 | item not valid (error-tag) |
Get lead details by ID
token | string | session token | |
id | string | lead ID |
200 | Ok! operation done succesufully |
400 | general error |
404 | not found |
405 | missing data required |
Retrieve leads list filtered by source code, tag and subscription date.
token | string | session token | |
tag | string | tag value ('new', 'lost', 'reject', 'suspend', 'error') | |
leadsource | string | custom source code | |
subscribe_dt_from | string | from subscribe date (YYYY-MM-DD) | |
subscribe_dt_to | string | to subscribe date (YYYY-MM-DD) |
200 | Ok! operation done succesufully |
400 | general error |
404 | not found |
405 | missing data required |