Skip to main content
POST
cURL

Quando usar

Você quer que o próprio cliente entregue o que falta. Escolha o modelo, o cadastro e os destinatários.

O cadastro é obrigatório

Por document (o cadastro é resolvido ou criado) ou por registryId. Um dos dois. A plataforma não avisa ninguém. A solicitação é criada, os links voltam em links[], e o lembrete também não sai. É o caminho para quem já fala com o cliente pelo canal próprio.

O que o cadastro já tem não é pedido de novo

Para pedir mesmo assim, liste as chaves de item em forceItemKeys.
Contexto e vocabulário em Solicitações de coleta. Autenticação, versionamento e capacidades em Visão geral da API.

Authorizations

Authorization
string
header
required

Enter JWT token

Body

application/json
template
string
required

Slug do modelo (ex.: onboarding-pj).

recipients
object[]
required
document
string

CNPJ ou CPF do cadastro.

registryId
string

Identificador do cadastro (Registry).

parties
object[]
dueInDays
number
default:7
message
string

Recado do operador ao destinatário.

responseMode
enum<string>

Sobrepõe o modo de resposta do modelo.

Available options:
AUTOMATIC,
REVIEW
channel
enum<string>

Sobrepõe o canal de envio do modelo. Use NONE para a plataforma não avisar ninguém: a solicitação é criada, os links são gerados e voltam na resposta (publicUrl quando há um destinatário, links[] sempre), e quem entrega é você. Lembrete também não sai.

Available options:
WHATSAPP,
EMAIL,
BOTH,
NONE
callbackUrl
string

Webhook do integrador (mesmo HMAC X-Gyra-Signature do cadastro).

forceItemKeys
string[]
draft
boolean

Cria a solicitação sem disparar o envio (rascunho).

send
boolean
default:true

Response

Solicitacao com id, status, dueAt, publicUrl, links[] por destinatario e a lista de itens.

A solicitacao criada. Quando ela e enviada na criacao, traz tambem os links: com channel NONE e por aqui que voce recebe o link para entregar. Os links so existem nesta resposta e na de envio.

id
string
registryId
string
templateId
string | null
templateSlug
string | null
templateName
string | null
templateVersion
integer | null
status
enum<string>
Available options:
DRAFT,
SENT,
IN_PROGRESS,
COMPLETED,
EXPIRED,
CANCELED
responseMode
enum<string>
Available options:
AUTOMATIC,
REVIEW
channel
enum<string>

NONE: a plataforma nao avisou ninguem e quem entrega o link e voce.

Available options:
WHATSAPP,
EMAIL,
BOTH,
NONE
reminders
integer[]

Dias apos o envio.

behavior
object

O comportamento herdado do modelo.

message
string | null

Recado do operador ao destinatario.

dueAt
string<date-time> | null
sentAt
string<date-time> | null
completedAt
string<date-time> | null
canceledAt
string<date-time> | null
subjectName
string | null

Resumo do cadastro alvo, para evitar uma segunda chamada.

subjectDocument
string | null
items
object[]
recipients
object[]
events
object[]

A trilha, append-only. O detalhe traz os 100 eventos mais recentes.

registry
object | null

O cadastro alvo: id, document, name e entityType.

itemsTotal
integer
itemsResolved
integer
itemsAwaitingOperator
integer

Itens esperando decisao humana (AWAITING_OPERATOR ou MANUAL_REVIEW).

progress
object

Contagem de itens (total, resolved, validated, awaitingOperator, rejected, pending) e de destinatarios (recipientsTotal, recipientsExpected, recipientsCompleted, recipientsWithoutItems).

createdAt
string<date-time>
updatedAt
string<date-time>
collectionId
string

O mesmo valor de id.

publicUrl
string | null

O link, quando ha um destinatario so. Com varios, vem null e a resposta e links.

Um link por destinatario enviado. Nao vem quando a solicitacao e criada como rascunho (draft true ou send false).

notified
boolean

false quando o canal e NONE: ninguem foi avisado e quem entrega o link e voce.