Sign in
Attributes

Update a status

Update a status on an status attribute on either an object or a list.

Required scopes: object_configuration:read-write.

patch/v2/{target}/{identifier}/attributes/{attribute}/statuses/{status}

Path parameters

target'lists' | 'objects' required

Whether the attribute is on an object or a list. Please note that company and person objects do not support status attributes at this time.

Example:lists
identifierstring required

A UUID or slug to identify the object or list the status attribute belongs to.

Example:33ebdbe9-e529-47c9-b894-0ba25e9c15c0
attributestring required

A UUID or slug to identify the attribute to update the status on.

Example:41252299-f8c7-4b5e-99c9-4ff8321d2f96
statusstring required

A UUID or status title to identify the status to update.

Example:In Progress

Request body

Example request

{
  "data": {
    "title": "In Progress",
    "celebration_enabled": true,
    "target_time_in_status": "P0Y0M1DT0H0M0S"
  }
}

Response

Success

Example response

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
      "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"
    },
    "title": "In Progress",
    "target_time_in_status": "P0Y0M1DT0H0M0S"
  }
}

Changes

Changed in 2 of the 6 revisions of this API.11

  • d2afbdc49fbc1See the full diff
    • ●

      added the new missing_value enum value to the code response property for the response status 400

      response-property-enum-value-added

  • 4ce2c28668d41See the full diff
    • ○

      the endpoint scheme security oauth2 was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog