{ "opencollection": "1.0.0", "info": { "name": "Attentive Access Token Subscribers API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Subscribers", "type": "folder" }, "items": [ { "info": { "name": "Get subscription eligibility for a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.attentivemobile.com/v1/subscriptions", "params": [ { "name": "phone", "value": "", "type": "query", "description": "A user's phone number we use to fetch subscription eligibility." }, { "name": "email", "value": "", "type": "query", "description": "A user's email we use to fetch subscription eligibility." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}", "accessTokenUrl": "https://api.attentivemobile.com/v1/authorization-codes/tokens", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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.\n" }, { "info": { "name": "Subscribe user", "type": "http" }, "http": { "method": "POST", "url": "https://api.attentivemobile.com/v1/subscriptions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}", "accessTokenUrl": "https://api.attentivemobile.com/v1/authorization-codes/tokens", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Make a call to this endpoint to opt-in a user to a subscription. \n\nNotes:\n- A legal disclosure is required when a user is opted-in programmatically.\n - For marketing messages, required [legal language](https://docs.attentivemobile.com/pages/legal-docs/legal-disclosure-language/) must be included.\n\n - For transactional messages, you must include a [transactional opt-in unit](https://docs.attentivemobile.com/pages/legal-docs/legal-transactional/).\n \n- By default, if a subscription already e" }, { "info": { "name": "Unsubscribe subscriptions for a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.attentivemobile.com/v1/subscriptions/unsubscribe", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}", "accessTokenUrl": "https://api.attentivemobile.com/v1/authorization-codes/tokens", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Make a call to this endpoint to unsubscribe a user from a subscription type or channel. If no subscriptions\nare present in the request, the user is unsubscribed from all subscriptions. If subscriptions are present\nin the request, the user is unsubscribed from the requested type or channel combination. By default, if a\nsubscription exists, but the user is already unsubscribed, it records the attempt to unsubscribe the\nsubscription again. For TEXT subscriptions, a message is sent to the person ind" } ] } ], "bundled": true }