Objetivo
Este endpoint tem o objetivo de editar um signatário que está inserido no envelope em questão, sendo possível editar informações como: nome, e-mail, telefone, tipo de assinatura e tipo de assinante.
URL
/rest/signer/IntegrationEnvelope/EnvelopeSignatory/edit
Parâmetros
Para realizar a requisição via API é necessário fazer a autenticação da chave de acesso do usuário, você pode encontrar o passo a passo para realizar essa etapa, clicando aqui.
EnvelopeId: Este é um parâmetro obrigatório na requisição, corresponde ao ID do envelope que o signatário desejado está inserido, pode ser obtido através dos seguintes endpoints:
- /rest/signer/IntegrationEnvelope – endpoint de criação de envelope, será recebido o EnvelopeId no retorno da requisição se o envelope for criado com sucesso
- /rest/signer/IntegrationEnvelope/ListEnvelope – endpoint para listar os envelopes no tenant, o endpoint irá listar todos os envelopes, com suas informações, incluindo o envelopeId
EnvelopeSignatoryId: Este é um parâmetro obrigatório na requisição, corresponde ao ID do signatário que serão editadas as informações dentro do envelope, este parâmetro pode ser obtido através dos seguintes endpoints:
- /rest/signer/IntegrationEnvelope/EnvelopeData – endpoint para detalhar as informações do envelope, inserindo o “envelopeId” na requisição, este endpoint retorna todas as informações do envelope, as quais contêm o EnvelopeSignatoryId
- /rest/signer/IntegrationEnvelope/ListEnvelope – endpoint para listar os envelopes no tenant, inserindo o “SSN” do signatário ou deixando vazio, o endpoint irá listar todos os envelopes, com suas informações, incluindo o EnvelopeSignatoryId
O envelope desejado deve estar em um dos seguintes status para que seja possível realizar a edição:
- Pendente – Quando o envelope está pendente para ser assinado
- Expirado – Quando a data limite de assinatura do envelope já passou
- Recusado – Quando algum dos signatários se recusa a assinar o documento. Se o envelope possuir somente 1 signatário e 1 documento, não poderá ser editado depois de recusado.
- Em autorização – Quando o envelope está aguardando o documento ser autorizado para assinatura
SignatoryName: Este é um parâmetro opcional, que poderá ser preenchido caso queira editar o nome do signatário dentro do envelope, caso não deseje alterar o nome do signatário, deixe o parâmetro vazio que ele não será alterado.
SignatoryMail: Este é um parâmetro opcional, que poderá ser preenchido caso queira editar o e-mail do signatário dentro do envelope, caso não deseje alterar o nome do signatário, deve deixar o parâmetro vazio, desta forma não será alterado. O endereço de e-mail inserido deve ser um endereço valido seguindo o formato padrão de um e-mail. Ex: exemplo@exemplo.com.
SignatoryPhone: Este é um parâmetro opcional, que poderá ser preenchido caso queira editar o telefone do signatário, sendo necessário ser preenchido com o seguinte formato: [Código do país] + [Código de área (DDD)] + [Número de telefone]. Ex.: +55 41 912345678 . Caso o usuário não deseje alterar o telefone do signatário, não deve enviar o parâmetro na requisição, desta forma não será alterado. Caso queira remover o numero, deve enviar o parâmetro vazio(Ex: ” “)desta forma será removido o telefone do contato.
Se o tenant não possuir a função de WhatsApp, será retornado um valor “false” no retorno do endpoint.
SignatureType: É um parâmetro que deve ser preenchido, ele define o tipo de assinatura que o signatário utilizará, sendo definido através dos seguintes enum:
- 0 – Eletrônica ou Digital
- 1 – Digital
- 2 – Eletrônica
- 3 – Presencial
SignerType: É um parâmetro que deve ser preenchido, ele define qual será o “Tipo de assinante” do signatário, deve ser preenchido com o enum correspondente á opção desejada, sendo elas:
- 0 – Signatário
- 1 – Testemunha
Retornos
O retorno do endpoint será de acordo com o resultado final da requisição, se for um erro devido a um parâmetro invalido, o retorno deverá informar qual parâmetro está invalido.
Quando a execução for feita com sucesso, o retorno será o código 200 indicando que a requisição foi executada corretamente, e no response body será retornado as novas informações que foram inseridas no signatário.
