API users

Visitor

GET https://api.commander1.com/v1.0/engage/visitors/

This endpoint allows you to

get properties for one specific visitor

. When you create the token, you can define which properties to return.

\

This API is more designed to be called from a tag in each user's browser.

Query Parameters

NameTypeDescription

callback

string

(optional) Callback for jsonp request

token

string

Security token

site

integer

ID of the site

tcid

string

Cookie id. If empty (recommanded) it will read the tcid in the user's cookie.

{
    "user_age": 39,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

User

GET https://api.commander1.com/engage/user/

This endpoint allows you to

get properties for one specific user

based on a

user_id

. When you create the token, you can define which properties to return.

Query Parameters

NameTypeDescription

token

string

Security token

user_id

string

ID of the user

site

integer

ID of the site

{
    "user_age": 39,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

User

PUT https://api.commander1.com/engage/user/

Insert or update a user

Query Parameters

NameTypeDescription

site

string

Id of the site (account)

user_id

string

Id of the user. Required if tc_id parameter is not set

token

string

Security token

{"success":true}

Example Request

PUT

https://api.commander1.com/engage/user/?site=1234&user_id=1234&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA

{
"preferences.channel":"email",
"preference.frequency":"30d",
...
}

DELETE user

Delete a user

Resource URL

https://api.commander1.com/engage/user/

Resource Information

Response formatsJSON

Requires authentication?

Yes (token)

Parameters

NAMEREQUIREMENTEXAMPLE VALUESDESCRIPTION

site

d+

1234

Id of the site

user_id

d+

1234

Id of the user

tc_id (optional)

d+

1234

Id of the visitor

token

[a-zA-Z0-9]*

WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA

Security token

Example Request

DELETE

https://api.commander1.com/engage/user/?site=1234&user_id=1234&tc_id=1234&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA

Response

{"success":true}

Last updated