Pular para o conteúdo principal
GET
Obter preferências de assinatura para um contato específico

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 caminho

subscriberIdString
string
obrigatório

O identificador exclusivo do assinante cujo status de preferências de comunicação está sendo obtido.

Parâmetros de consulta

channel
enum<string>
obrigatório

O canal de comunicação para o qual o status da assinatura está sendo obtido. Este parâmetro é obrigatório e atualmente aceita "EMAIL" como valor válido.

Opções disponíveis:
EMAIL
businessUnitId
integer<int64>

Um número inteiro opcional que representa o ID da unidade de negócios para filtrar o status da assinatura.

Resposta

successful operation

completedAt
string<date-time>
obrigatório

A data e a hora em que a operação foi concluída.

results
object[]
obrigatório

Uma série de resultados da operação.

startedAt
string<date-time>
obrigatório

A data e a hora em que a operação começou.

status
enum<string>
obrigatório

Indica o status atual da operação, com valores possíveis: PENDING, PROCESSING, CANCELED, COMPLETE.

Opções disponíveis:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Uma lista de erros que ocorreram durante a operação.

Contém URLs relacionados à resposta, como documentação ou recursos.

numErrors
integer<int32>

O número de erros que ocorreram durante a operação.

requestedAt
string<date-time>

A data e a hora em que a solicitação foi feita.

Última modificação em 10 de abril de 2026