Profile consent preference

This endpoint returns consent preference status for user profiles for projects where Consent Manager has been enabled.

Data returned includes details of the channel, type of preference status and any relevant consent-specific data, for example, channel (channel type). The response also includes an integer-boolean status (1 means the profile is currently subscribed to that channel and 0 is not.)

Examples

Get all consent preferences for a single user profile:

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/list/consent-preference-profile \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOUR_APPTOKEN",
    "condition": [
      ["user_id", "=", "USER_ID"]
    ]
  }'

Get all consent preferences for all user profiles which have status subscribed and have been updated after a specific point in time (timestamp must be provided in Unix):

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/list/consent-preference-profile \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOUR_APPTOKEN",
    "condition": [
      ["status", "=", "1"],
      ["update_time", ">", "1717229073"]
    ]
  }'