Get/put user consent stored in DataCommander
GET https://api.commander1.com/engage/user/
This endpoint allows you to get categorie's consent for one specific user
GET https://api.commander1.com/v1.0/engage/visitors/
This endpoint allows you to get categorie's consent for one specific visitor
PUT https://api.commander1.com/engage/user/
Insert or update a preference in the database (require to have the DataCommander module activated)
Syntax and limitations
The json playload is represented by a key/value for each preference.
Each preference property (key) start with "preferences." followed by the preference name : preferences.your_preference_name
The preference name should not contain white space, dot or special characters. Its format is [A-Za-z0-9_-]
Example Request
PUT
https://api.commander1.com/engage/user/?site=1234&user_id=1234&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA
The preference value can contain white space, dot but not special characters.
The API accepts a maximum of 20 preferences
token
string
Security token
user_id
string
ID of the user
site
integer
ID of the site
callback
string
(optional) Callback for jsonp request
token
string
Security token
site
integer
ID of the site
tc_id
String
Optional. Cookie id of the user
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
{
"user_privacy_optin": 1,
"user_privacy_categories": [
"11",
"12",
"13"
]
}{
"message": "Person not found"
}{
"user_privacy_optin": 1,
"user_privacy_categories": [
"11",
"12",
"13"
]
}{
"user_privacy_optin": 0,
"user_privacy_categories": []
}{
"message": "visitor not found"
}{"success":true}{
"preferences": {
"news_monthly": true,
"news_sales": true
}
}