PRproductive
Folders

Update a folder

Changed on

Updates a folder. Only the provided attributes are modified — rename it or toggle its visibility via hidden. To move a folder to a different project (which reassigns its task lists and tasks and remaps workflow statuses), use PATCH /folders/{id}/move instead.

patch/api/v2/folders/{id}

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/folders/{id}
  • Auth
    none declared

Path parameters

idstring required

The numeric ID of the folder.

Request body

Example request

{
  "data": {
    "type": "folders",
    "attributes": {
      "name": "Design (renamed)"
    }
  }
}

Response

A single folder resource response.

Example response

{
  "data": {
    "id": "5522",
    "type": "folders",
    "attributes": {
      "name": "Features",
      "position": 1,
      "placement": 1000000,
      "archived_at": null,
      "hidden": false
    },
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "6899"
        }
      }
    }
  },
  "included": []
}

Changes

  • fa3060fd0144Revision changes
    • warning

      added the new bad_decimal_format enum value to the // response property for the response status

    • warning

      added the new non_finite_number enum value to the // response property for the response status

    • warning

      added the new null_bytes_in_params enum value to the // response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 2eb527b17709Revision changes
    • info

      the request property // became optional

    • info

      the request property // became optional