Creating folders

How to create a folder or shared folder with the organization

Creating a folder

The mutation to create a folder in the authenticated user’s account (owner of the API token) is:

mutation CreateFolderMutation($parentId: UUID, $folder: FolderInput!) {
  createFolder(parent_id: $parentId, folder: $folder) {
    id
    name
    type
    created_at
    parentFolder {
      id
      name
    }
  }
}

Define the variable values:

{
  "parentId": "abc123",
  "folder": {
    "name": "Signed document"
  }
}

The field parentId is optional. If omitted, the folder will be created at the root level. To create a subfolder, provide the UUID of its parent folder.

If you want to create a document inside a folder, use the folder_id attribute when creating the document. If your goal is to add an existing document to another folder that has already been created, see how to move a document to a folder.

Each parent folder can contain up to five subfolders. Attempts to create additional subfolders will result in a validation error.

Renaming a folder

Use updateFolder to rename an existing folder.

mutation UpdateFolder($id: UUID!, $folder: FolderInput!) {
  updateFolder(id: $id, folder: $folder) {
    id
    name
    path
    updated_at
  }
}

Variables.

{
  "id": "FOLDER_UUID",
  "folder": {
    "name": "Finished contracts"
  }
}

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/

Autentique v2.postman_collection.json

19KB

Open

Para importar e usar no Postman