Criando Pastas

Como criar uma pasta normal ou compartilhada com a organização.

Criando uma pasta

A mutation para criar uma pasta na conta do usuário autenticado (titular do token de API) é:

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

Definindo os valores às variáveis:

{
  "parentId": "abc123",
  "folder": {
    "name": "Contratos assinados"
  }
}

O campo parentId é opcional. Quando ele não for informado, a pasta será criada na raiz. Para criar uma subpasta, envie o UUID da pasta principal.

Se você quer ter criar um documento em uma pasta, use o atributo folder_id na Criação do documento. Caso a intenção seja adicionar um documento existente em outra pasta já criada, veja como mover documento para uma pasta.

Existe um limite máximo de 5 subpastas por pasta pai. Tentativas de criar mais subpastas retornarão um erro de validação.

Renomeando uma pasta

Use updateFolder para alterar o nome de uma pasta existente.

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

Variáveis:

{
  "id": "UUID_DA_PASTA",
  "folder": {
    "name": "Contratos finalizados"
  }
}

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/

Autentique v2.postman_collection.json

19KB

Abrir

Para importar e usar no Postman