Moving document to a folder

How to move a document to a folder

To move a document to a folder, use the following mutation:

mutation {
  moveDocumentToFolder(
    document_id: "DOCUMENT_ID",
    folder_id: "FOLDER_DESTINATION_ID"
  )
}

And finally, testing this mutation in Altair:

If your document is already in a folder, you need to provide the parameter corresponding to its current folder using the current_folder_id attribute.

mutation {
  moveDocumentToFolder(
    document_id: "DOCUMENT_ID",
    current_folder_id: "CURRENT_FOLDER_ID",
    folder_id: "FOLDER_DESTINATION_ID"
  )
}

If you need to file a document into a group or organization folder, you'll also need to use the context attribute.

mutation {
  moveDocumentToFolder(
    document_id: "DOCUMENT_ID",
    folder_id: "FOLDER_DESTINATION_ID",
    context: ORGANIZATION # For organization folders, GROUP for group folders
  )
}

Lastly, to remove a document from a folder, set folder_id to null.

mutation {
  moveDocumentToFolder(
    document_id: "DOCUMENT_ID",
    folder_id: null
  )
}

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/

19KB

Autentique v2.postman_collection.json

Open

Para importar e usar no Postman