Pular para o conteúdo principal
POST
Gerar links de assinatura

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 gerar links. Deve ser 'EMAIL'.

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

O ID da unidade de negócio para a qual os links estão sendo gerados. O padrão é 0.

Corpo

application/json
subscriberIdString
string
obrigatório

O identificador exclusivo do assinante, representado como uma string. Esta propriedade é obrigatória.

language
string

O idioma em que o link de preferência de comunicação deve ser apresentado, representado como uma string.

subscriptionId
integer<int64>

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

Resposta

successful operation

managePreferencesUrl
string
obrigatório

Uma string de URL que direciona o assinante para uma página onde ele pode gerenciar suas preferências de comunicação.

subscriberIdString
string
obrigatório

O identificador exclusivo do assinante, representado como uma string.

unsubscribeAllUrl
string
obrigatório

Uma string de URL que permite ao assinante cancelar a inscrição de todas as comunicações.

unsubscribeSingleUrl
string

Uma string de URL que permite ao assinante cancelar a inscrição de um único tipo de comunicação.

Última modificação em 6 de outubro de 2026