GET/PUT Consents / preferences

Get/put user consent stored in DataCommander

User Consents

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

This endpoint allows you to get categorie's consent for one specific user

Query Parameters

Name	Type	Description
token	string	Security token
user_id	string	ID of the user
site	integer	ID of the site

200 Consent successfully retrieved.

{
    "user_privacy_optin": 1,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

404 Could not find a user matching this query.

{
    "message": "Person not found"
}

Visitor Consents

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

This endpoint allows you to get categorie's consent for one specific visitor

Query Parameters

Name	Type	Description
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

200 Example with optin response

{
    "user_privacy_optin": 1,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

202 Example with optout response

{
    "user_privacy_optin": 0,
    "user_privacy_categories": []
}

404

{
    "message": "visitor not found"
}

User

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

Insert or update a preference in the database (require to have the DataCommander module activated)

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
token	string	Security token

200

{"success":true}

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_-]

• The preference value can contain white space, dot but not special characters.

• The API accepts a maximum of 20 preferences

Example Request

PUT

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

{
  "preferences": {
    "news_monthly": true,
    "news_sales": true
  }
}