This endpoint will return subscription status changes for user profiles, for example email and SMS. This does not include subscription changes for devices.

Further information on user profiles, device profiles and attributes can be found in the guide on user data.

🚧
Logging of profile subscription changes is turned off by default and this API method will return empty result sets. If you believe you need access to this data, please contact us.

Examples

Get a single user profile's subscription status:

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

Get all user profile subscription statuses which have updated since a certain time:

curl --request POST \
  --url https://api.eu.xtremepush.com/api/external/list/profile-subscription \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOUR_APPTOKEN",
    "condition": [
      ["update_time", ">", 123123]
    ]
  }'

Data returned includes details of the channel and any relevant channel-specific data, for example, email_address. The response also includes an integer-boolean status value to indicate whether the subscription was added or removed and the integer-boolean update_is_external value, which indicates whether the status has been updated externally or not; when it’s set to 1, the permission was updated via file import or external API import; when it’s set to 0, the update occurred via SDK, a preference center linked included in an email/SMS or by manually editing the profile from the platform).