POST
/
customers
/
{id}
/
unsubscribe

Authorizations

Authorization
string
headerrequired

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

Body

application/json
type
enum<string>
required

The type of unsubscribe. campaign in this case indicates unsubscribing from a single campaign

Available options:
campaign
campaign_id
string
required

The ID of the campaign to unsubscribe from

Response

200 - application/json
id
string
required

The ID of the customer

email_address
string | null
required

The email address of the customer

phone_number
string | null
required

The phone number of the customer

metadata
any
required

The metadata associated with this customer

The Unsubscribe Embed objectCreate an unsubscribe embed