Skip to main content
GET
/
customers
/
{id}
/
unsubscribe_info
Retrieve unsubscribe info for a customer
curl --request GET \
  --url https://api.pocketflows.com/customers/{id}/unsubscribe_info \
  --header 'Authorization: Basic <encoded-value>'
{
  "unsubscribed_campaigns": [
    "<string>"
  ],
  "unsubscribed_triggers": [
    "<string>"
  ],
  "unsubscribed_from_all": true
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the customer

Response

200 - application/json

The marketing resources the customer has opted out of

unsubscribed_campaigns
string[]
required

The campaigns the customer has unsubscribed from

unsubscribed_triggers
string[]
required

The triggers the customer has unsubscribed from

unsubscribed_from_all
boolean
required

Whether the customer has opted out of all marketing

I