Aprovar anexos
Marque como válidos os arquivos que um assinante enviou, enquanto a operação está aberta.
Move o anexo de Review para Completed. É uma etapa de revisão dos arquivos
que o assinante enviou, feita enquanto a operação está aberta. Aprovar não
interfere na assinatura (que acontece uma única vez) — apenas marca o anexo como
conferido.
Máquina de estados. Slot criado → Progress (aguarda upload) → Review
(enviado, aguarda você) → Completed (após approve). Rejeição volta para
Progress, e o ciclo pode se repetir N vezes até você aprovar.
Só dá pra aprovar enquanto a operação está em andamento. Depois de finalizada
(você chamou /complete, ou ela fechou sozinha em modo automático quando o último
assinante assinou), a chamada retorna 400. Se precisa de tempo pra revisar os
anexos, crie a operação com finalização manual.
O que acontece quando você aprova
O status do anexo passa para Completed, registrando que foi você (via API key) quem aprovou.
A lista attachmentIds é processada em uma única transação. Se um ID falhar a validação, nenhum é aprovado.
Aprovar não dispara email/SMS/WhatsApp — é uma ação silenciosa de revisão do seu lado.
Aprovar um anexo já Completed retorna 400 informando que ele já estava aprovado.
Endpoint
Authorization
ApiKey Token de integracao. Envie no header X-Api-Key.
In: header
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "https://example.com/api/v2/attachment/approve" \ -H "Content-Type: application/json" \ -d '{}'Body
{
"operationMemberId": 4321,
"attachmentIds": [12345, 12346, 12347]
}| Campo | Tipo | Obrigatório | Notas |
|---|---|---|---|
operationMemberId | long | sim | ID do assinante dono dos anexos. Precisa ser > 0. |
attachmentIds | long[] | sim | Um ou mais IDs de anexos do mesmo membro. Não pode ser vazio. |
Todos os attachmentIds precisam pertencer ao operationMemberId informado.
Se um ID não for de um anexo daquele membro, a API responde 404 (anexo não
encontrado). Use Listar anexos por membro
pra obter os IDs corretos.
Resposta
200 OK. Não há corpo de dados — só a mensagem em messages:
{
"success": true,
"statusCode": 200,
"messages": [{ "value": "..." }]
}Erros comuns
| Status | Caso | Detalhe |
|---|---|---|
400 | attachmentIds vazio ou operationMemberId <= 0 | Falha de validação do corpo. |
400 | Operação já finalizada | Não é possível alterar anexos de uma operação finalizada. |
400 | Anexo já estava Completed | O anexo já estava aprovado. |
403 | Membro não existe ou pertence a outra conta | — |
403 | API key sem permissão de edição na operação | — |
404 | attachmentId informado não existe naquele membro | Anexo não encontrado. |