Objetivo
Este endpoint permite a remoção de documentos de um envelope por meio de requisições via API.
URL
/rest/signer/IntegrationEnvelopeFile/{envelopeId}/files
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 documento 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
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 após recusado.
- Em autorização – Quando o envelope está aguardando o documento ser autorizado para assinatura
FileId: Este é um parâmetro que corresponde ao numero de ID do arquivo que foi anexado no envelope. 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, nessas informações contem o FileId, no campo “File” ele está identificado como “id”
- /rest/signer/IntegrationEnvelope/ListEnvelope – endpoint para listar os envelopes no tenant, o endpoint irá listar todos os envelopes, com suas informações, incluindo o “FileId” que será encontrado no campo “Files” com o nome “id”.
- /rest/signer/IntegrationEnvelopeDocument – endpoint usado para fazer o upload de novos documentos no envelope, quando é feito o upload, o endpoint retorna o FileId do documento que foi anexado.
É possível fazer a remoção de mais de um documento por vez, sendo necessário colocar uma vírgula para separar cada um dos FileId a serem removidos. Ex: 12345 , 67891 .
Não é possível remover todos os documentos de um envelope. A partir do momento que o envelope possuir somente um documento restante, a requisição irá apontar erro ao tentar remover o documento.
Retornos
O retorno do endpoint será de acordo com o resultado da requisição, quando a requisição for bem sucedida, será retornado uma lista com os Id´s que restaram anexados no documento. Quando ocorrer algum erro, o retorno será uma mensagem de erro, informando qual tipo de erro ocorreu.
O envelope possuía 3 documentos e foi removido o documento do ID – 222331
Retornando somente os que restaram no envelope
Exemplo de um erro que acontece quando é passado o ID de um documento que não existe no envelope