collections

Enviar ou reenviar uma solicitacao

Dispara o envio para os destinatarios que ainda nao concluiram e devolve o detalhe da solicitacao com os links por destinatario.

Serve tanto para o primeiro envio de um rascunho quanto para reenviar um pedido que o cliente nao respondeu. Sem corpo: o recado do operador e o que foi gravado na criacao.

Com channel NONE ninguem e avisado (notified false) e os links voltam so nesta resposta.

post/v1/collections/{id}/send

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/v1/collections/{id}/send
  • Auth: HTTP bearer

Path parameters

idstring required

Id da solicitacao.

Response

O detalhe da solicitacao (mesmo corpo de GET /v1/collections/{id}) mais os links por destinatario, publicUrl e notified. Cada destinatario enviado traz tambem link.

idstring
registryIdstring
templateIdstring nullable
templateSlugstring nullable
templateNamestring nullable
templateVersioninteger nullable
status'DRAFT' | 'SENT' | 'IN_PROGRESS' | 'COMPLETED' | 'EXPIRED' | 'CANCELED'
responseMode'AUTOMATIC' | 'REVIEW'
channel'WHATSAPP' | 'EMAIL' | 'BOTH' | 'NONE'

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

remindersinteger[]

Dias apos o envio.

behaviorobject

O comportamento herdado do modelo.

messagestring nullable

Recado do operador ao destinatario.

dueAtstring date-time nullable
sentAtstring date-time nullable
completedAtstring date-time nullable
canceledAtstring date-time nullable
subjectNamestring nullable

Resumo do cadastro alvo, para evitar uma segunda chamada.

subjectDocumentstring nullable
itemsTotalinteger
itemsResolvedinteger
itemsAwaitingOperatorinteger

Itens esperando decisao humana (AWAITING_OPERATOR ou MANUAL_REVIEW).

progressobject

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

createdAtstring date-time
updatedAtstring date-time
collectionIdstring

O mesmo valor de id.

publicUrlstring nullable

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

notifiedboolean

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

Changes

No recorded changes to this operation across all 1 revision of this API.