Skip to content
/
Update Role

Update Role

Request

Updates an existing role's properties including name, department, capacity, and utilization targets.

Security
ApiKey
Path
idstring, (uuid)required

ID of the resource

Body
namestring or null

The name of the Role, typically describing the job function or skill set (e.g. Designer, Developer).

department_idstring or null, (uuid)

The unique identifier of the Department that this Role belongs to for capacity and reporting segmentation.

archivedboolean or null

Indicates whether this Role has been archived and is no longer active for planning or reporting.

curl -i -X PATCH \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/roles/{id}' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "department_id": "094fb5f1-8160-46ea-8cec-010c4b44e054",
    "archived": true
  }'

Responses

OK

Response
No content