v1

latestOpenAPI 3.0.32026-07-24235275.4 KB
Subscribers

Get subscription eligibility for a user

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

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