List User's Subscription Group Status - SMS

v1.0.0

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.

Input

{
  "type": "object",
  "properties": {
    "external_id": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "subscription_group_id": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}