v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

PUT Update folder

Com este endpoint você pode atualizar informações das pastas, caso precise alterar o nome, visibilidade ou departamentos da mesma.

Importante: O único item que não pode ser alterado é o Id, que é o identificador único da pasta e deve ser utilizado ao enviar documentos para ela.

put/api/folders/{identify}

Path parameters

identifystring required

Id da pasta que deve ser alterada.

Request body

namestring required

Novo nome para a pasta.

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

Visibilidade padrão da pasta.

departmentsinteger[]

IDs dos departamentos.

passwordstring

Define ou altera a senha do cofre. Deve conter no mínimo 4 caracteres. Ao informar este campo, a pasta é convertida automaticamente em um cofre protegido por senha.

old_passwordstring required

Senha atual da pasta. <br>• Se a pasta ainda não tiver senha, envie este campo vazio (""). <br>• Se já tiver uma senha, este campo deve conter a senha antiga. <br>• Se for remover a senha, envie vazio junto com password vazio.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Pasta editada com sucesso!",
  "data": {
    "name": "Empresa 1",
    "accessibility": "Everyone",
    "departments": "[64,99]"
  }
}