Envelope

Abaixo, você encontrará uma lista detalhada de todos os endpoints disponíveis para criar, ler, atualizar e excluir envelopes usando nossa API. Cada endpoint é acompanhado por uma breve descrição de sua função, permitindo que você integre nossa API em sua aplicação com facilidade.:

Endpoints Disponíveis

1. Listar Envelopes

  • Método: GET
  • Endpoint:/envelopes
  • Descrição: Lista todos os envelopes disponíveis, fornecendo detalhes básicos de cada envelope.
  • URL: Página de Referência.

2. Criar Envelope:

  • Método: POST
  • Endpoint:/envelopes
  • Descrição: Cria um envelope para iniciar o processo de assinatura eletrônica.
  • URL: Página de Referência.

3. Ativar Envelope [EM DESENVOLVIMENTO]:

  • Método: POST
  • Endpoint:/envelopes/{id}/activate
  • Descrição: Executa de forma assíncrona a ativação do envelope, retornando a resposta do processamento via webhook.
  • URL: Página de Referência .

4. Atualizar Envelope:)

  • Método: PATCH
  • Endpoint:/envelopes/{id}
  • Descrição: Atualiza os detalhes de um envelope existente, como adicionar/remover destinatários, documentos ou configurar notificações.
  • URL: Página de Referência .

5. Visualizar Envelope:

  • Método: GET
  • Endpoint:/envelopes/{id}
  • Descrição: Recupera os detalhes de um envelope específico com base no ID fornecido.
  • URL: Página de Referência.

6. Excluir Envelope:

  • Método: DELETE
  • Endpoint:/envelopes/{id}
  • Descrição: Exclui permanentemente um envelope e todos os seus documentos associados.
  • URL: Página de Referência.



❓Precisa de ajuda? Entre em contato com o Suporte

💰Dúvida sobre planos e preços? Veja o comparativo

🔍Não sabe qual versão está usando? Descubra a sua versão

📚Respostas rápidas? Visite nosso FAQ