List User's Subscription Group Status - SMS

GET https://{{instance_url}}/subscription/status/get?subscription_group_id={{subscription_group_id}}&external_id={{external_identifier}}&phone=+11112223333

Use the endpoint below to get the subscription state of a user in a subscription group. The response from this endpoint will include the external ID and either subscribed, unsubscribed, or unknown for the specific subscription group requested in the API call. This can be used to update the subscription group state in subsequent API calls or to be displayed on a hosted web page.

*Either external_id or email are required.

Response

All successful responses will return subscribed, unsubscribed, or unknown depending on status and user history with the subscription group.

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}

Request Params

The id of your subscription group. | | external_id | string | | (Required*) String

The external_id of the user (must include at least one and at most 50 external_ids).

Only external_id or phone is accepted for SMS subscription groups | | phone | string | | (Required*) String

The phone number of the user (must include at least one phone number and at most 50 phone numbers). The recommendation is to provide this in the E.164 format.

Only external_id or phone is accepted for SMS subscription groups |

HEADERS