PRproductive
Folders

Move a folder

Changed on

Moves a folder — and all of its task lists and tasks — to a different project. Provide the target project_id.

When the target project uses a different workflow than the source, a map of workflow status IDs is required: keys are the source workflow's status IDs, values are the target workflow's status IDs. The map must cover every status in the source workflow.

Tasks are reassigned to the target project and their statuses remapped accordingly. Assignees and subscribers who are not members of the target project are removed from the moved tasks.

{
  "data": {
    "type": "folders",
    "attributes": {
      "project_id": 31055,
      "map": { "101": 205, "102": 206, "103": 207 }
    }
  }
}
patch/api/v2/folders/{id}/move

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}/move
  • Auth
    none declared

Path parameters

idstring required

The numeric ID of the folder.

Request body

Example request

{
  "data": {
    "type": "folders",
    "attributes": {
      "project_id": 31055,
      "map": {
        "101": 205,
        "102": 206,
        "103": 207
      }
    }
  }
}

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

  • f11a8740641aRevision changes
    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the // response's property type changed from integer to no type for status

    • breaking

      the // response's property type changed from integer to no type for status

    • warning

      deleted the header request parameter X-Organization-Id

    • info

      added to the // response property anyOf list for the response status

    • info

      added to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the // response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the // response property anyOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    This list may be incomplete.