---
title: "Update an Annotation Category"
method: PATCH
path: "/annotation_categories/{id}"
tags: ["Annotations"]
---

# Update an Annotation Category

`PATCH /annotation_categories/{id}`

## Request

- Base URL: `https://connect-au.catapultsports.com/api/v6`
- URL: `https://connect-au.catapultsports.com/api/v6/annotation_categories/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/catapultsports/apis/openfield-connect-v6-api/docs/annotation_categories/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update an annotation category

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `import_name` string: defaults to the value from 'name' when absent
  - `start_offset` integer: Pre-roll in whole seconds
  - `end_offset` integer: Post-roll in whole seconds
  - `default_color` string: HTML color, e.g. #FF5500, the color to use for annotations of this type
  - `is_bakeable` integer: 0(false) or 1(true) annotation category should be baked. If is_event = 1 then is_bakeable will be 0
  - `is_event` integer: 0(false) or 1(true). An event might be a single event in time (like a Goal Keeper Save) vs a period of time (like ball in possession)

## Response `200`

Updated annotation category object

- object: Annotation Category
  - `id` string
  - `name` string: Display name
  - `import_name` string: Internal name
  - `start_offset` integer: Pre-roll in whole seconds
  - `end_offset` integer: Post-roll in whole seconds
  - `default_color` string: HTML color, e.g. #FF5500, the color to use for annotations of this type
  - `is_bakeable` integer: 0(false) or 1(true) annotation category should be baked. If is_event = 1 then is_bakeable will be 0
  - `is_event` integer: 0(false) or 1(true). An event might be a single event in time (like a Goal Keeper Save) vs a period of time (like ball in possession)
  - `created_at` string
  - `modified_at` string
  - `is_editable` integer

## Other responses

- `401`: Unauthenticated
- `422`: Request validation failed

---

[API](https://skmtc.dev/catapultsports/apis/openfield-connect-v6-api.md) - [All operations](https://skmtc.dev/catapultsports/apis/openfield-connect-v6-api/llms.txt) - [OpenAPI document](https://skmtc.dev/catapultsports/apis/openfield-connect-v6-api/revisions/4f0d7082f399?raw)