PLplugsign

PUT Update folder

Changed on

Com este endpoint você pode atualizar o nome, a visibilidade, os departamentos e a senha de uma pasta. O ID não pode ser alterado.

Importante: name é sempre obrigatório, mesmo para alterar só a visibilidade. Para trocar a senha do cofre, envie password (nova senha) e old_password (senha atual). Se old_password estiver errada, a senha não muda, mas os demais campos são atualizados e a resposta continua 200. Este endpoint não define a primeira senha de uma pasta criada sem senha nem remove a senha de um cofre.

put/api/folders/{identify}

Request

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

Path parameters

identifyinteger required

ID numérico da pasta que deve ser alterada.

Request body

namestring required

Nome da pasta (obrigatório em toda chamada; reenvie o nome atual se não quiser alterá-lo).

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

Visibilidade da pasta. OnlyMe é gravado como Only Me.

departmentsinteger[]

IDs dos departamentos. Departamentos de outra empresa respondem 422.

passwordstring

Nova senha do cofre, com no mínimo 4 caracteres. Exige old_password. Enviar vazio não remove a senha.

old_passwordstring

Senha atual do cofre. Obrigatória apenas quando password é informado. Se estiver incorreta, a senha é mantida e a resposta ainda é 200.

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]"
  }
}

Changes

  • 3db1513040eaRevision changes
    • breaking

      for the path request parameter identify, the type changed from string to integer

    • warning

      added the new Only Me enum value to the / response property for the response status

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the OnlyMe enum value from the / response property for the response status