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

Autorizaciones

Authorization

string

header

requerido

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

Parámetros de consulta

channel

enum<string>

requerido

El canal de comunicación para el que se generan los enlaces. Debe ser "EMAIL".

Opciones disponibles:

EMAIL

businessUnitId

integer<int64>

predeterminado:0

El identificador de la unidad de negocio. Por defecto es 0 si no se especifica.

Cuerpo

application/json

subscriberIdString

string

requerido

Una cadena que representa el identificador único del suscriptor. Esta propiedad es obligatoria.

language

string

El idioma en el que se debe presentar el enlace generado, representado como una cadena.

subscriptionId

integer<int64>

El identificador único de la suscripción, representado como un número entero en formato int64.

Respuesta

successful operation

managePreferencesUrl

string

requerido

La URL donde el suscriptor puede gestionar sus preferencias de comunicación.

subscriberIdString

string

requerido

Una cadena que representa el identificador único del suscriptor.

unsubscribeAllUrl

string

requerido

Una cadena que contiene la URL para dar de baja al suscriptor de todas las comunicaciones.

unsubscribeSingleUrl

string

Una cadena que contiene la URL para dar de baja al suscriptor de una sola comunicación.