Pular para o conteúdo principal
POST
Ler status 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

Uma string obrigatória que indica o canal de comunicação para filtrar. O valor válido é 'EMAIL'.

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

O ID da unidade de negócio para filtrar os status. É um número inteiro.

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