Generate a subscription center token

Generates a signed token and URL for a person's standalone subscription center page. The token is valid for 24 hours.

Use the returned url to link people to a hosted subscription center page where they can manage their subscription preferences outside of a message. This is useful when you want to provide a direct link to the subscription center—for example, in your app's account settings or in a custom email.

The customer_id path parameter is the person's identifier (e.g. an email address or customer ID) as it appears in Customer.io. The identifier must match an existing person in your workspace.

get/v1/subscription_center/{customer_id}/token

Path parameters

customer_idstring required

Example:person@example.com

The identifier for a person in your workspace—the same value you'd use as an id or email to identify a person in Customer.io.

Response

Returns a signed token and a subscription center url for the person.

tokenstring

A signed token representing the person's subscription center session. The token expires after 24 hours.

If you want to use a custom link tracking domain, you can point your customers to https://<your-tracking-domain>/u/i/<your-token>/<language-code (optional)>.

urlstring

A full URL to the person's standalone subscription center page. You can use this URL directly as a link.

Example response

{
  "url": "https://track.customer.io/u/i/<your-token>/"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.