Edita a cadeia de signatários de uma solicitação pendente e encadeada (enviada com chain: true). As operações são executadas na ordem enviada: update troca o e-mail de um signatário, remove retira um signatário, add insere um novo signatário (com seus campos) e update_additional_info altera nome, CPF ou data de nascimento.
Solicitações não encadeadas, não pendentes ou de outra empresa respondem 404; operações inválidas (e-mail fora da cadeia, por exemplo) respondem 422.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Atualização da cadeia de assinatura
Exemplos
Substituir o e-mail de um signatário (update)
{
"signing_key": "SUA_CHAVE_AQUI",
"operations": [
{ "action": "update", "target_email": "[email protected]", "new_email": "[email protected]" }
]
}Adicionar um signatário no fim da cadeia (add)
{
"signing_key": "SUA_CHAVE_AQUI",
"operations": [
{
"action": "add",
"new_email": "[email protected]",
"after_email": "last",
"fullname": "João da Silva",
"cpf": "11111111111",
"fields": [
{ "type": "signature", "page": 1, "xPos": 100, "yPos": 500, "width": 200, "height": 60 }
]
}
]
}after_email aceita um e-mail já presente na cadeia, beginning (início) ou last (fim). Quando fields não é informado, as posições dos campos são copiadas do signatário anterior.
Remover um signatário (remove)
{
"signing_key": "SUA_CHAVE_AQUI",
"operations": [
{ "action": "remove", "target_email": "[email protected]" }
]
}Atualizar os dados cadastrais de um signatário (update_additional_info)
{
"signing_key": "SUA_CHAVE_AQUI",
"operations": [
{ "action": "update_additional_info", "target_email": "[email protected]", "fullname": "João da Silva", "cpf": "22222222222", "birthdate": "1990-01-15" }
]
}Atualizar um signatário da cadeia (update_recipient)
{
"signing_key": "SUA_CHAVE_AQUI",
"operations": [
{
"action": "update_recipient",
"target_email": "[email protected]",
"new_email": "[email protected]",
"fullname": "João da Silva",
"allow_cpf": false,
"doubleauth": true,
"doubleauth_cpf": "52998224725",
"fields": [
{ "type": "signature", "page": 1, "xPos": 100, "yPos": 500, "width": 200, "height": 60 }
]
}
]
}update_recipient permite atualizar o signatário atual ou um próximo participante da cadeia. target_email identifica o participante e aceita e-mail ou telefone válido. new_email é opcional. A action altera somente as propriedades enviadas e não reenvia o convite. Se fields for enviado, ele substitui todas as posições do participante. subject e reminder só podem ser alterados para participantes futuros, pois o signatário atual já recebeu o convite.
Várias operações em uma única chamada
As operações são executadas na ordem enviada. É possível combinar update, add, remove, update_additional_info e update_recipient no mesmo array operations.
Resposta de sucesso (200)
{
"message": "Cadeia de assinatura atualizada com sucesso.",
"chain_emails": ["[email protected]", "[email protected]"],
"warnings": []
}Regras
- A solicitação precisa estar com status Pending e possuir cadeia de assinatura (
chain_emails); caso contrário a resposta é404. - A empresa do token precisa ser a mesma da solicitação.
- Um contato que não existe na cadeia responde
422com a descrição do erro no campoerror.update_recipienttambém pode localizar o signatário atual pelo contato do request. removeretira o signatário de todas as listas da cadeia (e-mails, posições, opções e dados cadastrais).update_additional_infoaltera apenas os dados cadastrais. Quandonew_emailé enviado nessa ação para o signatário atual, a API atualiza o contato somente nos dados adicionais e devolve um aviso emwarnings. Para alterar o contato do signatário atual no request, useupdate_recipientouPUT /api/requests/change-signer.
