Excluir Signatário
Remove um signatário de um envelope. A remoção só é permitida enquanto o envelope estiver com status DRAFT.
Endpoint
DELETE /v1/envelopes/{id}/signers/{signerId}
Headers
| Header | Valor |
|---|---|
| Authorization | Bearer {token} |
Parâmetros de URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do envelope |
signerId | integer | Sim | ID do signatário a ser removido |
Exemplo de Requisição
curl -X DELETE https://api.tapsign.com.br/v1/envelopes/1523/signers/4821 \
-H "Authorization: Bearer {token}"
Resposta de Sucesso
Status: 204 No Content
A resposta não possui corpo. O status 204 confirma que o signatário foi removido.
Erros
| Código | Quando acontece |
|---|---|
400 | O envelope não está em DRAFT |
400 | O signatário não pertence ao envelope informado |
401 | Chave de API ou token ausente ou inválido |
404 | Envelope inexistente ou de outro usuário, ou signatário inexistente |
O formato do corpo de erro está em Status de Erros.
Restrição importante
Após o envio do envelope, não é possível remover signatários. Se precisar tirar um signatário de um envelope já enviado, cancele o envelope e crie um novo sem ele.
Atenção
A API permite remover todos os signatários de um rascunho, mas um envelope sem nenhum signatário não pode ser enviado: o envio exige pelo menos um signatário, de qualquer papel.