v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Create folder

Com este endpoint você pode criar pastas no sistema, também é possível criar subpastas para melhor organização dos documentos.

Ao criar uma pasta você irá receber o Id da mesma, que é o identificador único dela no sistema, que pode ser utilizado para recuperar documentos e até mesmo enviar documentos para pastas específicas.

post/api/folders

Request body

folderinteger

ID da pasta onde a nova pasta será criada. Caso não seja informado, a pasta será criada diretamente na raiz.

namestring required

Nome da pasta visível dentro da plataforma

accessibility'Everyone' | 'Departments' | 'OnlyMe'

Visibilidade padrão da pasta.

departmentsinteger[]

Só é obrigatório se no campo de acesso passar departamentos, recebe uma lista dos departamentos da empresa que passam a ter acesso a pasta.

passwordstring

Ao informar uma senha, a pasta passa a ser tratada como um cofre, exigindo autenticação de senha para acesso ao seu conteúdo.

Response

200

Example response

{
  "data": {
    "id": 1,
    "folder": "public_folder",
    "accessibility": "Everyone",
    "created_on": "26/11/2024 14:24:25"
  }
}