collections

Criar uma solicitacao de documentos ao cliente

Cria o pedido a partir de um MODELO e manda o link para um ou mais destinatarios.

O modelo diz O QUE se pede (documento, formulario, termo, assinatura, identidade); aqui voce diz PARA QUEM e SOBRE QUEM. Use list_collection_templates para descobrir os modelos disponiveis.

O cadastro e obrigatorio, por document (CNPJ/CPF, e o cadastro e resolvido ou criado) ou por registryId. Um dos dois.

CANAL: EMAIL, WHATSAPP, BOTH, ou NONE. Com NONE a plataforma NAO avisa ninguem: a solicitacao e criada, os links voltam na resposta (publicUrl e links[]) e quem entrega e voce. Lembrete tambem nao sai. E o caminho para quem ja fala com o cliente pelo canal proprio.

O que o cadastro ja tem e validado nao e pedido de novo. Para pedir mesmo assim, liste as chaves em forceItemKeys.

Com draft: true (ou send: false), cria sem enviar.

post/v1/collections

Request

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

Request body

templatestring required

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

documentstring

CNPJ ou CPF do cadastro.

registryIdstring

Identificador do cadastro (Registry).

dueInDaysnumber
messagestring

Recado do operador ao destinatário.

responseMode'AUTOMATIC' | 'REVIEW'

Sobrepõe o modo de resposta do modelo.

channel'WHATSAPP' | 'EMAIL' | 'BOTH' | 'NONE'

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.

callbackUrlstring

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

forceItemKeysstring[]
draftboolean

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

sendboolean

Response

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

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.