Documentação
HomePainelChaves de API
API v2
API v2
  • Introdução
  • Sobre o GraphQL
  • Preços para uso via API
  • Integrando com a API
    • Usando o Altair
    • Sandbox/testes
    • Webhooks
    • Webhooks (deprecado)
    • Mensagens de erro
  • Queries
    • Buscar Usuário Atual
    • Resgatando Documentos
    • Listar Organizações
    • Listando Pastas
    • Listando Modelos de Email
  • Mutations
    • Criando um Documento
    • Assinando um Documento
    • Editando um Documento
    • Removendo um Documento
    • Transferindo um Documento
    • Adicionar Signatário
    • Remover Signatário
    • Criando Pastas
    • Removendo Pastas
    • Movendo Documento para Pasta
    • Reenviar Assinaturas
    • Criar Link de Assinatura
    • Aprovar Verificação Biométrica Pendente
    • Rejeitar Verificação Biométrica Pendente
Fornecido por GitBook
Nesta página

Isto foi útil?

  1. Mutations

Removendo um Documento

Como excluir um documento criado.

AnteriorEditando um DocumentoPróximoTransferindo um Documento

Atualizado há 8 meses

Isto foi útil?

Para excluir um documento, deve-se utilizar a seguinte mutation:

mutation {
  deleteDocument(id: "ID_DO_DOCUMENTO")
}

Parâmetros:

  • id: String (UUID!) que representa o identificador único do documento que você deseja excluir.

Resposta esperada:

{
  "data": {
    "deleteDocument": true
  }
}

IMPORTANTE: A mutation de deletar documentos possui a mesma funcionalidade de exclusão que o painel, e NÃO bloqueia o documento, ou seja, caso o documento já tenha sido assinado por alguma das partes, ele será apenas movido para a lixeira do usuário que realizou o request. Nesses casos, é recomendado realizar uma requisição de atualizar documento e informar o campo `deadline_at` para o momento atual, assim bloqueando o documento.

Você pode conferir o que é cada um desses parâmetros direto na documentação completa da API GraphQL, no menu Docs do . Se você não sabe como fazer isso, confira o nosso tutorial em .

Se o Altair não te ajuda para integrar com a API, confira alguns exemplos de como fazer essas requisições de outra forma:

Altair
Usando o Altair
https://graphql.org/graphql-js/graphql-clients/