Generate subscription links

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

Supported products

Required Scopes

Autorisations

Authorization

string

header

requis

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

Paramètres de requête

channel

enum<string>

requis

Le canal de communication pour lequel les liens sont générés. Doit être « EMAIL ».

Options disponibles:

EMAIL

businessUnitId

integer<int64>

défaut:0

L'identifiant de l'unité commerciale. La valeur par défaut est 0 si non spécifiée.

Corps

application/json

subscriberIdString

string

requis

Une chaîne représentant l'identifiant unique de l'abonné. Cette propriété est obligatoire.

language

string

La langue dans laquelle le lien généré doit être présenté, représentée sous forme de chaîne de caractères.

subscriptionId

integer<int64>

L'identifiant unique de l'abonnement, représenté sous forme d'entier au format int64.

Réponse

successful operation

managePreferencesUrl

string

requis

L'adresse URL où l'abonné peut gérer ses préférences de communication.

subscriberIdString

string

requis

Une chaîne représentant l'identifiant unique de l'abonné.

unsubscribeAllUrl

string

requis

Une chaîne contenant l'URL permettant de désabonner l'abonné de toutes les communications.

unsubscribeSingleUrl

string

Une chaîne contenant l'URL permettant de désabonner l'abonné d'une communication unique.