Subscribers

Get subscription eligibility for a user

Changed on

Make a call to this endpoint to list all subscription types and channels a user is subscribed to. You can query for a subscriber using either their phone number or email. One of the query parameters is required in order to look up a subscriber. As an example, you can use this endpoint to check if a subscriber is eligible to receive SMS or email campaigns, and then send them a message based on that eligibility.

get/subscriptions

Request

  • Base URL
    https://api.attentivemobile.com/v1
  • Auth
    OAuth 2
    Authorization code: https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}
    Token URL: https://api.attentivemobile.com/v1/authorization-codes/tokens scopes: subscriptions:read

Query parameters

phonestring
Example:%2B13115552368

A user's phone number we use to fetch subscription eligibility.

emailstring
Example:test@gmail.com

A user's email we use to fetch subscription eligibility.

Response

Successfully accepted get subscriptions request

Changes

    • warning

      added the new CONTACT enum value to the /// response property for the response status