Atualizar Signatário

Atualiza os dados de um signatário de um envelope em rascunho (DRAFT). Só os campos enviados com valor são alterados: campos omitidos ou enviados como null mantêm o valor atual.

Endpoint

PUT /v1/envelopes/{id}/signers/{signerId}

Headers

Header	Valor
Authorization	Bearer {token}
Content-Type	application/json

Parâmetros de URL

Parâmetro	Tipo	Obrigatório	Descrição
id	integer	Sim	ID do envelope
signerId	integer	Sim	ID do signatário

Body

Todos os campos são opcionais. Envie apenas os que deseja alterar.

Campo	Tipo	Descrição
name	string	Nome do signatário, de 2 a 100 caracteres
email	string	E-mail do signatário. Não pode repetir o e-mail de outro signatário do mesmo envelope
phone	string	Telefone em formato internacional, com + opcional (ex: +5511999999999)
role	string	Papel: SIGNER, WITNESS, APPROVER, ACKNOWLEDGE_RECEIPT, AUTHORIZE ou CUSTOM
authMethods	string[]	Métodos de autenticação: SCREEN_SIGNATURE, EMAIL_CODE, SMS_CODE ou WHATSAPP_CODE. Uma lista vazia volta para SCREEN_SIGNATURE

Não dá para apagar um campo

Como null significa "manter o valor atual", este endpoint não remove dados. Por exemplo, não é possível tirar o telefone de um signatário: um texto vazio em phone é recusado pela validação de formato.

Restrição importante

Signatários só podem ser atualizados enquanto o envelope estiver com status DRAFT. Depois do envio, os dados do signatário ficam bloqueados.

Exemplo de Requisição

curl -X PUT https://api.tapsign.com.br/v1/envelopes/1523/signers/4821 \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "João Pedro da Silva",
    "email": "[email protected]"
  }'

Resposta de Sucesso

Status: 200 OK

Retorna o signatário atualizado, com os mesmos campos descritos em Adicionar Signatário.

{
  "id": 4821,
  "envelopeId": 1523,
  "name": "João Pedro da Silva",
  "email": "[email protected]",
  "phone": "+5511999999999",
  "role": "SIGNER",
  "signOrder": 1,
  "status": "PENDING",
  "signedAt": null,
  "declinedAt": null,
  "declineReason": null,
  "accessToken": "3f6c2a9e-8b1d-4c7a-9e2f-5d4b8a1c0e77",
  "whatsappLastStatus": null,
  "whatsappLastStatusAt": null,
  "whatsappLastErrorCode": null,
  "whatsappOwnerMessage": null,
  "signaturePage": null,
  "signaturePosX": null,
  "signaturePosY": null,
  "signatureWidth": null,
  "signatureHeight": null,
  "authMethods": ["SCREEN_SIGNATURE"]
}

Erros

Código	Quando acontece
400	Campo com formato inválido. A resposta traz o motivo de cada campo em fields
400	O envelope não está em DRAFT
400	O signatário não pertence ao envelope informado
400	Já existe outro signatário com o novo e-mail neste envelope
400	authMethods contém um método indisponível
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.

Dica

Se você precisa corrigir o e-mail de um signatário após o envio do envelope, cancele o envelope, crie um novo e adicione o signatário com os dados corretos.