Skip to content
Optiwork API Docs

Update a category

PATCH
/categories/{category}
curl --request PATCH \
  --url https://flow.work.optidata.cloud/api/categories/993 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Onboarding (2026)", "description": "Everything a new hire needs in the first month." }'

Renames a category, rewrites its description or changes its visibility. The caller must own the category or have manage access to it.

Send the full set of editable fields: name is required, and an omitted description is cleared. An omitted visibility is kept. Categories that mirror a group take their name from the group and cannot be changed here.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
category
required
integer

Id of the category. Read it from GET /categories.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

Category name, unique within the company.

string
<= 255 characters
description
string | null
<= 255 characters
visibility

Who can see a category. restricted: only the people and groups it is shared with. internal: everyone in the company. public: anyone with the link, including people who are not signed in.

string
Allowed values: restricted internal public
Examples
Examplerename
{
  "name": "Onboarding (2026)",
  "description": "Everything a new hire needs in the first month."
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The updated category.

Media typeapplication/json
object
id
required
integer
name
required
string
slug
required

URL-friendly form of the name.

string
description
string | null
visibility
required

Who can see a category. restricted: only the people and groups it is shared with. internal: everyone in the company. public: anyone with the link, including people who are not signed in.

string
Allowed values: restricted internal public
is_public
required

Shortcut for visibility == public.

boolean
identifier

Short public identifier of the category.

string | null
user_id

Id of the user who owns the category, when it has one.

integer | null
group_id

Set when the category mirrors a group: it is shared with the group’s members, and its name and description follow the group’s.

integer | null
cuid

Identifier of the company the category belongs to.

string
created_at
string format: date-time
updated_at
string format: date-time
deleted_at

Set when the category is in the trash.

string | null format: date-time
Examples
Exampleupdated
{
  "id": 993,
  "cuid": "7f3c2a10-5b8e-4d21-9c6a-0e4f1b2d3c4a",
  "name": "Onboarding (2026)",
  "slug": "onboarding-2026",
  "description": "Everything a new hire needs in the first month.",
  "created_at": "2026-10-19T13:50:38.000000Z",
  "updated_at": "2026-10-19T13:52:05.000000Z",
  "deleted_at": null,
  "visibility": "restricted",
  "user_id": 20,
  "identifier": "jYpV3A",
  "group_id": null,
  "is_public": false
}

401

Section titled “401”

No authentication key was sent.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The caller lacks the access this operation needs.

Media typeapplication/json

Generic error envelope used by permission, lookup and framework failures.

object
message
required
string
Examples
Exampledenied
{
  "message": "This action is unauthorized."
}

404

Section titled “404”

No such resource — or it does not belong to the category or page in the path.

Media typeapplication/json

Generic error envelope used by permission, lookup and framework failures.

object
message
required
string
Examples
Examplemissing
{
  "message": "No query results for model [App\\Models\\Page] 999999"
}

419

Section titled “419”

The authentication key is expired or not recognised. Get a fresh one and retry.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Exampleexpired
{
  "error": "JWT passport expired: Passport expired"
}

422

Section titled “422”

The body failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}