Update a role

​

Partial update: only the fields sent change.

Path Parameters

  • id
    Type: stringFormat: uuid
    required

    Role id.

Body·

required
application/json

Any subset of writable fields. At least one is required. Unknown or read-only fields are rejected.

  • category
    Type: string | null
  • label
    Type: string | null
  • order
    Type: number | null
  • status
    Type: "inactive" or "active" or nullenum

    Active roles are assignable; inactive are retired.

  • teamId
    Type: string | nullFormat: uuid

    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.weddingoperatingsystems.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",
  "teamId": null,
  "order": null,
  "category": null
}'

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "label": null,
    "status": "inactive",
    "teamId": null,
    "order": null,
    "category": null,
    "createdTime": "2026-09-30T06:22:05.746Z",
    "lastEditedTime": "2026-09-30T06:22:05.746Z"
  }
}

The updated role.