POST Create folder

post

https://app.plugsign.com.br/api/folders

Com este endpoint você pode criar pastas no sistema, inclusive subpastas, para organizar os documentos.

A resposta é 201 Created com o registro da pasta criada (sem envelope data). Guarde o id: ele é o identificador usado nos demais endpoints de pastas e no upload de documentos.

Quando accessibility não é informado, a pasta é criada como Everyone. Informar password transforma a pasta em um cofre: a senha passa a ser exigida para acessar os documentos no sistema.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

folder

int32

ID da pasta-mãe onde a nova pasta será criada. Se omitido, a pasta é criada na raiz (id 1). A pasta-mãe precisa existir e pertencer à sua empresa; caso contrário a resposta é 422.

name

string

required

Nome da pasta visível dentro da plataforma

accessibility

string

enum

Visibilidade da pasta. Padrão: Everyone. O valor OnlyMe é gravado e devolvido como Only Me.

Allowed:

departments

array of int32s

IDs dos departamentos da empresa que terão acesso quando accessibility for Departments. Não é obrigatório (é possível criar com Departments sem informar departamentos). Departamentos de outra empresa respondem 422.

departments

password

string

Senha do cofre (até 255 caracteres). Ao informar uma senha, a pasta passa a exigir autenticação para acesso aos documentos no sistema. A senha é armazenada como hash.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Pasta criada. A resposta é o registro da pasta, sem envelope data.

422Erro de validação