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
Name | Type | Description |
---|---|---|
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
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
Name | Type | Description |
---|---|---|
token | string | Security token |
user_id | string | ID of the user |
site | integer | ID of the site |
User
PUT
https://api.commander1.com/engage/user/
Insert or update a user
Query Parameters
Name | Type | Description |
---|---|---|
site | string | Id of the site (account) |
user_id | string | Id of the user. Required if tc_id parameter is not set |
tc_id | string | Optional. Cookie id of the user |
token | string | Security token |
Example Request
PUT
https://api.commander1.com/engage/user/?site=1234&user_id=1234&tc_id=1234&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA
DELETE user
Delete a user
Resource URL
https://api.commander1.com/engage/user/
Resource Information
Response formats | JSON |
Requires authentication? | Yes (token) |
Parameters
NAME | REQUIREMENT | EXAMPLE VALUES | DESCRIPTION |
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
Last updated