Generate subscription links

curl --request POST \ --url https://api.hubapi.com/communication-preferences/v4/links/generate \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "subscriberIdString": "<string>", "language": "<string>", "subscriptionId": 123 } '

Supported products

Required Scopes

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

channel

enum<string>

required

The communication channel for which to generate links. Must be 'EMAIL'.

Available options:

EMAIL

businessUnitId

integer<int64>

default:0

The ID of the business unit for which the links are being generated. Defaults to 0.

Body

application/json

subscriberIdString

string

required

The unique identifier for the subscriber, represented as a string. This property is required.

language

string

The language in which the communication preference link should be presented, represented as a string.

subscriptionId

integer<int64>

The unique identifier for the subscription, represented as an integer.

Response

successful operation

managePreferencesUrl

string

required

A URL string that directs the subscriber to a page where they can manage their communication preferences.

subscriberIdString

string

required

The unique identifier for the subscriber, represented as a string.

unsubscribeAllUrl

string

required

A URL string that allows the subscriber to unsubscribe from all communications.

unsubscribeSingleUrl

string

A URL string that allows the subscriber to unsubscribe from a single communication type.