Endpoint de edição de envelope – Editar configurações

Objetivo

Este endpoint tem o objetivo de fornecer ao usuário a possibilidade de edição das configurações do envelope através de uma requisição via API.

URL

/rest/signer/IntegrationEnvelope/{envelopeId}/edit-info

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 será alterado as configurações, pode ser obtido através dos seguintes endpoint:

• /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.
  

O envelope que será alterado as configurações deve estar em um dos seguintes status para que seja possível realizar a edição das configurações

• 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.
• Em autorização – Quando o envelope está aguardando o documento ser autorizado para assinatura.

Title: Nesse campo você deve inserir um título ao envelope, o campo é do tipo “String”, um parâmetro obrigatório na requisição para editar as configurações do envelope, caso não queira alterar o título do envelope, enviar a requisição sem o parâmetro (apagar) ou deixar somente as “aspas” no parâmetro.

Message: Nesse campo deve ser definido a descrição do envelope, do tipo “String”, parâmetro opcional na requisição, caso não queira alterar a descrição ao envelope, enviar a requisição sem o parâmetro, (apagar) caso queira deixar a descrição vazia, deixar o parâmetro em “branco” (somente as aspas).

Expiration: Data de expiração do envelope, logo, após a data definida o envelope será expirado, esse campo deve ser preenchido no formato “Data” (2025-08-28), caso não queira que o envelope tenha uma expiração, deve enviar a requisição com o parâmetro em “branco”.

Language: Idioma do envelope, do tipo “Enum”, parâmetro obrigatório na requisição, esse campo deve ser preenchido com:

1. para o idioma do envelope ser em Português
2. para o idioma do envelope ser em Inglês
3. para o idioma do envelope ser em Espanhol

ReminderFrequency: Esse campo define a frequência de envio de notificações ao signatário, para os signatários que ainda não assinaram o envelope, parâmetro obrigatório na requisição, deve ser preenchido no formato de “Enum” então, deve ser usado:

1. para o sistema não enviar notificações
2. para o sistema enviar todos os dias
3. para o sistema enviar a cada 2 dias
4. para o sistema enviar a cada 4 dias
5. para o sistema enviar a cada 7 dias

SegmentCode: Nesse campo você deve preencher com o código de segmento do envelope, se tiver um segmento específico para esse envelope. Caso não deseje especificar um segmento, preencher com o valor “0” para se tornar “Nulo” no retorno.

NeedAuth: Esse campo é um parâmetro obrigatório e define se vai existir uma autenticação antes do signatário acessar o envelope. É do tipo “Boolean”, então deve ser preenchido com “True” para exigir que o signatário realize uma autenticação antes de acessar o envelope, e “False”, para que o signatário não precise realizar a autenticação.

IsRejectable: Nesse campo você deve preencher seguindo o formato “Boolean”, ele é um parâmetro obrigatório na requisição do endpoint e define se o signatário terá a opção de recusar o envelope. Deve ser preenchido com “True” para que o signatário tenha a opção de recusar o envelope e “False” para que o signatário não tenha a opção de recusar o envelope, sendo assim, tornando a assinatura obrigatória para que o envelope seja concluído.

Parâmetros obrigatórios não podem ser deixados em branco.

Retornos: 

O retorno do endpoint será de acordo com o resultado final da requisição, se for um erro devido a um parâmetro preenchido de forma incorreta, não seguindo as instruções acima, seja “Boolean”, “Enum” ou “String” , o retorno deverá informar qual o parâmetro que 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 configurações do envelope.