collections

Decidir sobre um item em revisao

A decisao do operador sobre um item em AWAITING_OPERATOR, MANUAL_REVIEW, REJECTED, SUBMITTED ou PROCESSING. Em outro status, responde 409. Cada item aceita ate 3 pedidos de reenvio; depois disso, aprove ou dispense.

Tres saidas:

  • APPROVED: o item fecha;
  • RESEND_REQUESTED: o destinatario recebe o pedido de novo. O comentario e OBRIGATORIO aqui, e e ele que o cliente le, entao escreva o que precisa ser corrigido, nao o codigo do check;
  • WAIVED: o item sai do pedido.
post/v1/collections/{id}/items/{itemId}/review

Request

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

Path parameters

idstring required

Id da solicitacao.

itemIdstring required

Id do item.

Request body

decision'APPROVED' | 'RESEND_REQUESTED' | 'WAIVED' required
commentstring

Obrigatorio em RESEND_REQUESTED: e o texto que o destinatario le. Opcional nas outras decisoes.

Response

O detalhe da solicitacao inteira, ja com o item no status resultante (mesmo corpo de GET /v1/collections/{id}). APPROVED leva o item a VALIDATED, WAIVED a WAIVED e RESEND_REQUESTED de volta a PENDING, com o comentario em rejectionReason.

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.