Folders

Update a folder

Changed on

Updates the name of an existing folder.

put/folders/{folderId}

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/folders/{folderId}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

folderIdstring required

The ID of the Folder

Request body

namestring required

Display name.

Response

Example response

{
  "data": {
    "id": "qtFsOkIjKKYBoZxta91x7A",
    "createdBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes