Skip to main content
POST
Recuperar status de assinatura em lote

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 filtrar os status de assinatura. Deve ser 'EMAIL'.

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

Um número inteiro opcional que representa o ID da unidade de negócio. Este parâmetro ajuda a filtrar os resultados com base na unidade de negócio específica.

Corpo

application/json
inputs
string[]
obrigatório

Uma lista de strings que representam as entradas para operações em lote.

Resposta

successful operation

completedAt
string<date-time>
obrigatório

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

results
object[]
obrigatório

A série de resultados do processo em lote, cada um contendo informações de status da assinatura.

startedAt
string<date-time>
obrigatório

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

status
enum<string>
obrigatório

O status atual do processo em lote, com valores possíveis: PENDING, PROCESSING, CANCELED, COMPLETE.

Opções disponíveis:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

Uma coleção de links relacionados associados à resposta em lote.

requestedAt
string<date-time>

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

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