Sign in

v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Status

Generate subscription links

Generate communication preference links for a subscriber. This endpoint allows you to create URLs for managing preferences and unsubscribing, tailored to a specific subscriber. It is useful for integrating communication preference management into your applications.

post/communication-preferences/2026-03/links/generate

Query parameters

channel'EMAIL' required

The communication channel for which the links are generated. Must be 'EMAIL'.

businessUnitIdinteger

The identifier of the business unit. Defaults to 0 if not specified.

Request body

languagestring

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

subscriberIdStringstring required

A string representing the unique identifier of the subscriber. This property is required.

subscriptionIdinteger

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

Response

successful operation

managePreferencesUrlstring required

The URL where the subscriber can manage their communication preferences.

subscriberIdStringstring required

A string representing the unique identifier of the subscriber.

unsubscribeAllUrlstring required

A string containing the URL for unsubscribing the subscriber from all communications.

unsubscribeSingleUrlstring

A string containing the URL to unsubscribe the subscriber from a single communication.