collections

Cancelar uma solicitacao

Encerra a solicitacao. Corpo opcional, com reason de ate 500 caracteres. Os links param de funcionar e nenhum lembrete sai.

O motivo fica na trilha.

post/v1/collections/{id}/cancel

Request

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

Path parameters

idstring required

Id da solicitacao.

Request body

reasonstring

Motivo do cancelamento.

Response

O detalhe da solicitacao, ja em CANCELED (mesmo corpo de GET /v1/collections/{id}).

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

Changes

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