Update a role
Partial update: only the fields sent change.
Path Parameters
- Type: stringFormat: uuididrequired
Role id.
Body·
required
application/json
Any subset of writable fields. At least one is required. Unknown or read-only fields are rejected.
- Type: string | nullcategory
- Type: booleandefault
_on _gig Every new gig starts with an open slot for this role (e.g. Band Leader, Coordinator).
- Type: string | nulllabel
- Type: number | nullorder
- Type: "inactive" or "active" or nullenumstatus
Active roles are assignable; inactive are retired.
- Type: string | nullFormat: uuidteam
_id The role grouping used for ordering and display (replaces the legacy Section). References teams.id.
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
- application/json
Request Example for patch/roles/{id}
curl https://api.hireorpheus.com/api/v1/roles/123e4567-e89b-12d3-a456-426614174000 \
--request PATCH \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"label": null,
"status": "inactive",
"team_id": null,
"order": null,
"category": null,
"default_on_gig": true
}'
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"label": null,
"status": "inactive",
"team_id": null,
"order": null,
"category": null,
"default_on_gig": true,
"created_time": "2026-10-14T08:02:53.592Z",
"last_edited_time": "2026-10-14T08:02:53.592Z"
}
}