Pular para o conteúdo principal
POST
/
communication-preferences
/
2026-03
/
links
/
generate
Gerar links de assinatura
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
}
'
{
  "managePreferencesUrl": "<string>",
  "subscriberIdString": "<string>",
  "unsubscribeAllUrl": "<string>",
  "unsubscribeSingleUrl": "<string>"
}

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de consulta

channel
enum<string>
obrigatório

O canal de comunicação para o qual os links são gerados. Deve ser 'EMAIL'.

Opções disponíveis:
EMAIL
businessUnitId
integer<int64>
padrão:0

O ID da unidade de negócio associada à solicitação. O padrão é 0.

Corpo

application/json
subscriberIdString
string
obrigatório

Uma string que representa o identificador exclusivo do assinante. Esta propriedade é obrigatória.

language
string

O idioma em que o link gerado deve ser apresentado, representado como uma string.

subscriptionId
integer<int64>

O identificador exclusivo da assinatura, representado como um número inteiro no formato int64.

Resposta

successful operation

managePreferencesUrl
string
obrigatório

O URL onde o assinante pode gerenciar suas preferências de comunicação.

subscriberIdString
string
obrigatório

Uma string que representa o identificador exclusivo do assinante.

unsubscribeAllUrl
string
obrigatório

Uma string contendo o URL para cancelar a inscrição do assinante de todas as comunicações.

unsubscribeSingleUrl
string

Uma string contendo o URL para cancelar a inscrição do contato de uma única comunicação.

Last modified on April 13, 2026