Recusar como participante aprovador

Sandbox

POST

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

Registra a recusa de um participante com papel de aprovador, quando é a vez dele, com o mesmo motivo (10 a 500 caracteres) exigido na tela. Exige o recurso "aprovação pela API" liberado para a conta. A recusa encerra o envelope como recusado, igual à recusa pelo link, e o histórico a registra como feita pela integração, com o nome do aprovador. Aprovador de grupo, aprovador que já aprovou ou já recusou, e envelope que não está em andamento são recusados.

Requisição

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

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//decline' \
--header 'Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data '{
    "reason": "stringstri"
}'

Response Example

200 - Exemplo 1

{
    "participantId": "string",
    "status": "DECLINED",
    "declinedVia": "API"
}

Modificado em 2026-09-28 20:20:30

Página anterior

Aprovar participante aprovador

Próxima página

Corrigir contato do participante