PRproductive
Workflow Statuses

Update an workflow status

Changed on

Update a workflow status.

patch/api/v2/workflow_statuses/{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/workflow_statuses/{id}
  • Auth
    none declared

Path parameters

idstring required

ID

Request body

Example request

{
  "data": {
    "type": "workflow_statuses",
    "attributes": {
      "name": "In Review",
      "color_id": "6",
      "category_id": 2
    },
    "relationships": {
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "75"
        }
      }
    }
  }
}

Response

Single workflow status

Example response

{
  "data": {
    "id": "224",
    "type": "workflow_statuses",
    "attributes": {
      "name": "In Progress",
      "color_id": "5",
      "position": 2,
      "category_id": 2
    },
    "relationships": {
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "75"
        }
      }
    }
  },
  "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

      response property data/attributes/color_id list-of-types was widened by adding types null and string to media type application/vnd.api+json of response 200

    • warning

      deleted the header request parameter X-Organization-Id

    This list may be incomplete.