Aprovar participante aprovador

Sandbox

POST

/v4/api/envelopes/{envelopeId}/participants/{participantId}/approve

Registra a aprovação de um participante com papel de aprovador, quando é a vez dele. Exige o recurso "aprovação pela API" liberado para a conta. O histórico registra a aprovação como feita pela integração, com o nome do aprovador. Repetir a chamada depois de aprovado devolve 200 com alreadyApproved: true, sem gravar de novo. Signatários não podem ser aprovados por esta operação.

Requisição

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

Sucesso

Headers

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠409

🟠422Erro de Parâmetro

🟠429

🔴503Serviço Indisponível

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v4/api/envelopes//participants//approve' \
--header 'Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data '{
    "documentNumber": "string"
}'

Response Example

200 - Exemplo 1

{
    "approvalId": "string",
    "participantId": "string",
    "status": "APPROVED",
    "approvedAt": "2019-08-24T14:15:22.123Z",
    "alreadyApproved": true,
    "approvedVia": "API"
}

Modificado em 2026-09-17 15:17:52

Página anterior

Listar participantes do envelope

Próxima página

Sincronizar participantes