Skip to main content
POST
Atualizar o status de assinatura de um contato

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 atualizado.

Corpo

application/json
channel
enum<string>
obrigatório

O tipo de canal de comunicação, com "EMAIL" como a única opção suportada.

Opções disponíveis:
EMAIL
statusState
enum<string>
obrigatório

O status atual da assinatura do contato, que pode ser "SUBSCRIBED", "UNSUBSCRIBED" ou "NOT_SPECIFIED".

Opções disponíveis:
NOT_SPECIFIED,
SUBSCRIBED,
UNSUBSCRIBED
subscriptionId
integer<int64>
obrigatório

O identificador exclusivo da assinatura a ser atualizada.

A base jurídica para comunicação, com opções incluindo "LEGITIMATE_INTEREST_PQL", "LEGITIMATE_INTEREST_CLIENT", "PERFORMANCE_OF_CONTRACT", "CONSENT_WITH_NOTICE", "NON_GDPR", "PROCESS_AND_STORE" e "LEGITIMATE_INTEREST_OTHER".

Opções disponíveis:
CONSENT_WITH_NOTICE,
LEGITIMATE_INTEREST_CLIENT,
LEGITIMATE_INTEREST_OTHER,
LEGITIMATE_INTEREST_PQL,
NON_GDPR,
PERFORMANCE_OF_CONTRACT,
PROCESS_AND_STORE

Uma explicação para a base jurídica usada para comunicação.

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