CRUD
Items

Update an existing item

Returns updated item with its sanitised data.<br/>Requirements:<br/>- auth-client scopes: "workspace"<br/>- user permission: "write" or higher

put/api/workspaces/{workspaceId}/items/{itemId}

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/workspaces/{workspaceId}/items/{itemId}
  • Auth: HTTP bearer

Path parameters

workspaceIdstring uuid required

ID of the workspace which contains the managed items.

itemIdstring uuid required

Query parameters

actAsAdminboolean

Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.

Request body

archivedboolean

Whether this item is archived.

assigneeUserGroupIdsstring[]

Ids of user groups that are assigned to this item.

assigneeUserIdsstring[]

Ids of users who are assigned to this item.

color'amber' | 'azure' | 'black' | 'blue' | 'coco' | 'daulphine' | 'emerald' | 'fanta' | 'granite' | 'great' | 'leaf' | 'moss' | 'mutedAmber' | 'mutedAzure' | 'mutedBlack' | 'mutedBlue' | 'mutedCoco' | 'mutedDaulphine' | 'mutedEmerald' | 'mutedFanta' | 'mutedGranite' | 'mutedGreat' | 'mutedLeaf' | 'mutedMoss' | 'mutedOcean' | 'mutedOrange' | 'mutedPink' | 'mutedPurple' | 'mutedRed' | 'mutedSky' | 'mutedViolet' | 'mutedYellow' | 'ocean' | 'orange' | 'pink' | 'purple' | 'red' | 'sky' | 'violet' | 'yellow'
fieldsobject

Values of custom fields, where each key is a custom-field ID and each value is a JSON-formatted value of the corresponding field. Entries present in the map replace the matching entry on the item; entries omitted from the map are left untouched.

namestring

Name (title) of this item.

orderinteger

Order number of this item for sorting.

statusIdstring uuid

Id of the status of this item.

Example request

{
  "description": {
    "blocks": [
      {
        "content": [
          {
            "content": "hello world",
            "type": "text"
          }
        ],
        "type": "paragraph"
      }
    ],
    "richText": true
  },
  "fields": {
    "0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
      "number": 42
    },
    "34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
      "boolean": true
    },
    "5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
      "userGroupIds": [
        "70e2b87a-b774-3022-9ef0-e55031a1c4fb"
      ],
      "userIds": [
        "24c9e15e-52af-347c-a25b-757e7bee1f9d"
      ]
    },
    "75fe57ec-4a04-3a30-8cac-5f27223df81a": {
      "dateRange": {
        "endDate": "2024-02-14",
        "startDate": "2024-01-14",
        "timezone": "UTC"
      }
    },
    "8be74552-df93-331b-bdd6-b36ed74bdb6a": {
      "selection": [
        "2bb225ce-b5ee-3493-967c-fde0d72da242"
      ]
    },
    "c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
      "text": "A platform built for the new way of doing product management"
    },
    "c9c0d13b-a4e5-363b-a475-736cd0366142": {
      "richText": {
        "blocks": [
          {
            "content": [
              {
                "content": "This is a rich text field with ",
                "type": "text"
              },
              {
                "content": [
                  {
                    "content": "bold text",
                    "type": "text"
                  }
                ],
                "type": "bold"
              },
              {
                "content": " and ",
                "type": "text"
              },
              {
                "content": [
                  {
                    "content": "italic text",
                    "type": "text"
                  }
                ],
                "type": "italic"
              },
              {
                "content": ".",
                "type": "text"
              }
            ],
            "type": "paragraph"
          }
        ],
        "richText": true
      }
    },
    "e34d514f-7db5-38aa-872a-7c8191a09617": {
      "date": {
        "date": "2024-01-01",
        "timezone": "UTC"
      }
    }
  }
}

Response

archivedboolean required

Whether this item is archived.

assigneeUserGroupIdsstring[] required

Ids of user groups that are assigned to this item.

assigneeUserIdsstring[] required

Ids of users who are assigned to this item.

color'amber' | 'azure' | 'black' | 'blue' | 'coco' | 'daulphine' | 'emerald' | 'fanta' | 'granite' | 'great' | 'leaf' | 'moss' | 'mutedAmber' | 'mutedAzure' | 'mutedBlack' | 'mutedBlue' | 'mutedCoco' | 'mutedDaulphine' | 'mutedEmerald' | 'mutedFanta' | 'mutedGranite' | 'mutedGreat' | 'mutedLeaf' | 'mutedMoss' | 'mutedOcean' | 'mutedOrange' | 'mutedPink' | 'mutedPurple' | 'mutedRed' | 'mutedSky' | 'mutedViolet' | 'mutedYellow' | 'ocean' | 'orange' | 'pink' | 'purple' | 'red' | 'sky' | 'violet' | 'yellow' required
createdAtstring date-time required

Timestamp of when this item was created.

fieldsobject required

Values of custom fields, where each key is a custom-field ID and each value is a JSON-formatted value of the corresponding field.

idstring uuid required

Unique identifier of this item.

lastUpdatedAtstring date-time required

Timestamp of when this item was last updated.

namestring required

Name (title) of this item.

numberinteger

A numeric id of this item, which is used to create an alias to this item like DEV-123. The number is unique within the workspace, and defined by server on item creation.

orderinteger required

A order number of this item for sorting.

statusCategoryUpdatedAtstring date-time

Timestamp of when the status of this item was last time switched from one category to another.

statusIdstring uuid required

Id of the status of this item.

statusUpdatedAtstring date-time

Timestamp of when the status of this item was last updated.

workspaceIdstring uuid required

Id of the workspace this workspace belongs to.

Example response

{
  "_embedded": {
    "children": [
      {
        "item": {
          "description": {
            "blocks": [
              {
                "content": [
                  {
                    "content": "hello world",
                    "type": "text"
                  }
                ],
                "type": "paragraph"
              }
            ],
            "richText": true
          },
          "fields": {
            "0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
              "number": 42
            },
            "34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
              "boolean": true
            },
            "5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
              "userGroupIds": [
                "70e2b87a-b774-3022-9ef0-e55031a1c4fb"
              ],
              "userIds": [
                "24c9e15e-52af-347c-a25b-757e7bee1f9d"
              ]
            },
            "75fe57ec-4a04-3a30-8cac-5f27223df81a": {
              "dateRange": {
                "endDate": "2024-02-14",
                "startDate": "2024-01-14",
                "timezone": "UTC"
              }
            },
            "8be74552-df93-331b-bdd6-b36ed74bdb6a": {
              "selection": [
                "2bb225ce-b5ee-3493-967c-fde0d72da242"
              ]
            },
            "c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
              "text": "A platform built for the new way of doing product management"
            },
            "c9c0d13b-a4e5-363b-a475-736cd0366142": {
              "richText": {
                "blocks": [
                  {
                    "content": [
                      {
                        "content": "This is a rich text field with ",
                        "type": "text"
                      },
                      {
                        "content": [
                          {
                            "content": "bold text",
                            "type": "text"
                          }
                        ],
                        "type": "bold"
                      },
                      {
                        "content": " and ",
                        "type": "text"
                      },
                      {
                        "content": [
                          {
                            "content": "italic text",
                            "type": "text"
                          }
                        ],
                        "type": "italic"
                      },
                      {
                        "content": ".",
                        "type": "text"
                      }
                    ],
                    "type": "paragraph"
                  }
                ],
                "richText": true
              }
            },
            "e34d514f-7db5-38aa-872a-7c8191a09617": {
              "date": {
                "date": "2024-01-01",
                "timezone": "UTC"
              }
            }
          }
        }
      }
    ],
    "parents": [
      {
        "item": {
          "description": {
            "blocks": [
              {
                "content": [
                  {
                    "content": "hello world",
                    "type": "text"
                  }
                ],
                "type": "paragraph"
              }
            ],
            "richText": true
          },
          "fields": {
            "0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
              "number": 42
            },
            "34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
              "boolean": true
            },
            "5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
              "userGroupIds": [
                "70e2b87a-b774-3022-9ef0-e55031a1c4fb"
              ],
              "userIds": [
                "24c9e15e-52af-347c-a25b-757e7bee1f9d"
              ]
            },
            "75fe57ec-4a04-3a30-8cac-5f27223df81a": {
              "dateRange": {
                "endDate": "2024-02-14",
                "startDate": "2024-01-14",
                "timezone": "UTC"
              }
            },
            "8be74552-df93-331b-bdd6-b36ed74bdb6a": {
              "selection": [
                "2bb225ce-b5ee-3493-967c-fde0d72da242"
              ]
            },
            "c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
              "text": "A platform built for the new way of doing product management"
            },
            "c9c0d13b-a4e5-363b-a475-736cd0366142": {
              "richText": {
                "blocks": [
                  {
                    "content": [
                      {
                        "content": "This is a rich text field with ",
                        "type": "text"
                      },
                      {
                        "content": [
                          {
                            "content": "bold text",
                            "type": "text"
                          }
                        ],
                        "type": "bold"
                      },
                      {
                        "content": " and ",
                        "type": "text"
                      },
                      {
                        "content": [
                          {
                            "content": "italic text",
                            "type": "text"
                          }
                        ],
                        "type": "italic"
                      },
                      {
                        "content": ".",
                        "type": "text"
                      }
                    ],
                    "type": "paragraph"
                  }
                ],
                "richText": true
              }
            },
            "e34d514f-7db5-38aa-872a-7c8191a09617": {
              "date": {
                "date": "2024-01-01",
                "timezone": "UTC"
              }
            }
          }
        }
      }
    ]
  },
  "description": {
    "blocks": [
      {
        "content": [
          {
            "content": "hello world",
            "type": "text"
          }
        ],
        "type": "paragraph"
      }
    ],
    "richText": true
  },
  "fields": {
    "0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
      "number": 42
    },
    "34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
      "boolean": true
    },
    "5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
      "userGroupIds": [
        "70e2b87a-b774-3022-9ef0-e55031a1c4fb"
      ],
      "userIds": [
        "24c9e15e-52af-347c-a25b-757e7bee1f9d"
      ]
    },
    "75fe57ec-4a04-3a30-8cac-5f27223df81a": {
      "dateRange": {
        "endDate": "2024-02-14",
        "startDate": "2024-01-14",
        "timezone": "UTC"
      }
    },
    "8be74552-df93-331b-bdd6-b36ed74bdb6a": {
      "selection": [
        "2bb225ce-b5ee-3493-967c-fde0d72da242"
      ]
    },
    "c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
      "text": "A platform built for the new way of doing product management"
    },
    "c9c0d13b-a4e5-363b-a475-736cd0366142": {
      "richText": {
        "blocks": [
          {
            "content": [
              {
                "content": "This is a rich text field with ",
                "type": "text"
              },
              {
                "content": [
                  {
                    "content": "bold text",
                    "type": "text"
                  }
                ],
                "type": "bold"
              },
              {
                "content": " and ",
                "type": "text"
              },
              {
                "content": [
                  {
                    "content": "italic text",
                    "type": "text"
                  }
                ],
                "type": "italic"
              },
              {
                "content": ".",
                "type": "text"
              }
            ],
            "type": "paragraph"
          }
        ],
        "richText": true
      }
    },
    "e34d514f-7db5-38aa-872a-7c8191a09617": {
      "date": {
        "date": "2024-01-01",
        "timezone": "UTC"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.