CMO Control Management Organizer
2.20
7
API Server

auth

2
GET

auth/login

REFERENCE

Login into system using operator. Creates a session token, to be used in all subsequent calls.

PARAMETERS
username string A valid username.
password password Password
Call Resource
/
auth
/
login.php
Request
GET https://api-cmo.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
401 unauthorized
404 not found
GET

auth/logout

REFERENCE

Logout from system and destroy the session token.

PARAMETERS
token string session token
Call Resource
/
auth
/
logout.php
Request
GET https://api-cmo.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found

leads

5
GET

leads/addlead

REFERENCE

Add new lead with minimal data

PARAMETERS
token string session token
email 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)
Call Resource
/
leads
/
addlead.php
Request
GET https://api-cmo.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
GET

leads/checkbyemail

REFERENCE

Check exists lead entry by email address.

PARAMETERS
token string session token
email string email address
Call Resource
/
leads
/
checkbyemail.php
Request
GET https://api-cmo.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
406 item not valid (blacklisted)
407 item not valid (error-tag)
GET

leads/checkbyphone

REFERENCE

Check exists lead entry by email address.

PARAMETERS
token string session token
phone string phone number (without internal space)
Call Resource
/
leads
/
checkbyphone.php
Request
GET https://api-cmo.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
406 item not valid (blacklisted)
407 item not valid (error-tag)
GET

leads/loadbyid

REFERENCE

Get lead details by ID

PARAMETERS
token string session token
id string lead ID
Call Resource
/
leads
/
loadbyid.php
Request
GET https://api-cmo.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
GET

leads/loadlist

REFERENCE

Retrieve leads list filtered by source code, tag and subscription date.

PARAMETERS
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)
Call Resource
/
leads
/
loadlist.php
Request
GET https://api-cmo.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required