Removing a document

How to delete a created document.

To delete a document, you must use the following mutation:

mutation {
  deleteDocument(id: "DOCUMENT_ID")
}

Parameters:

• id: A String (UUID!) that represents the unique identifier of the document you want to delete.

Expected response?

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

IMPORTANT: The delete document mutation functions the same way as deleting from the dashboard — it does not block the document. This means that if the document has already been signed by any of the parties, it will only be moved to the trash of the user who made the request.

In such cases, it is recommended to perform an update document request and set the deadline_at field to the current time. This effectively blocks the document from further signing.

You can check what each of these parameters means directly in the full GraphQL API documentation, in the Docs menu of Altair. If you're not sure how to do that, check out our tutorial on Using Altair.

If Altair doesn't help you integrate with the API, check out some examples of how to make these requests in other ways: https://graphql.org/graphql-js/graphql-clients/