Removendo um Documento

Como excluir um documento criado.

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 Altair. Se você não sabe como fazer isso, confira o nosso tutorial em Usando o Altair.

Se o Altair não te ajuda para integrar com a API, confira alguns exemplos de como fazer essas requisições de outra forma: https://graphql.org/graphql-js/graphql-clients/

Last updated