PLplugsign

POST Create folder

Changed on

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.

post/api/folders

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/folders
  • Auth
    API key in header Authorization

Request body

folderinteger

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.

namestring required

Nome da pasta visível dentro da plataforma

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

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

departmentsinteger[]

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

passwordstring

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.

Response

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

idinteger

ID da pasta criada.

namestring

Nome da pasta.

accessibility'Everyone' | 'Departments' | 'Only Me'

Visibilidade gravada.

passwordstring

Hash da senha quando a pasta é um cofre; string vazia quando não há senha.

departmentsstring

IDs dos departamentos como string JSON (ex.: "[64,99]") ou string vazia.

created_byinteger

ID do usuário que criou a pasta.

created_onstring

Data e hora de criação (dd/mm/aaaa hh:mm:ss).

folderinteger

ID da pasta-mãe (1 = raiz).

companyinteger

ID da empresa.

Changes

  • 3db1513040eaRevision changes
    • breaking

      removed the success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status