ATattentive
Subscribers

Unsubscribe subscriptions for a user

Changed on

Make a call to this endpoint to unsubscribe a user from a subscription type or channel. If no subscriptions are present in the request, the user is unsubscribed from all subscriptions. If subscriptions are present in the request, the user is unsubscribed from the requested type or channel combination. By default, if a subscription exists, but the user is already unsubscribed, it records the attempt to unsubscribe the subscription again. For TEXT subscriptions, a message is sent to the person indicating that they are unsubscribed.

For the user object, the email data point determines which email subscriptions a user has and the phone data point determines which text (or sms) subscriptions a user has. Passing in an email does not locate, nor unsubscribe, a user from any sms subscriptions. Similarly, passing in a phone does not locate, nor unsubscribe, a user from any email subscriptions.

post/subscriptions/unsubscribe

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:write

Request body

Example request

{
  "user": {
    "phone": "+13115552368",
    "email": "test@gmail.com"
  }
}

Response

Accepted an unsubscribe subscription(s) request. The response body will contain info about which subscription(s) are already unsubscribed, and which subscription(s) will be unsubscribed (asynchronously).

Example response

{
  "user": {
    "phone": "+13115552368",
    "email": "test@gmail.com"
  }
}

Changes

  • 472218fbe3dcRevision changes
    • warning

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

    • info

      added the new CONTACT enum value to the request property //