v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB

Job Roles

Update A Specific Job Role

This endpoint updates a specific job role. <h3>Required Scope</h3>job_roles:write

patch/api/v2/job-roles/{id}

Path parameters

idstring required

The ID of the job role to update.

Request body

Example request

{
  "data": {
    "type": "job-roles",
    "attributes": {
      "role-id": "RoleID123",
      "name": "Product Designer",
      "description": "Product Designer role",
      "data": [
        {
          "type": "skills",
          "id": "Prototyping",
          "meta": {
            "target-level": 4,
            "priority": 1
          }
        }
      ]
    }
  }
}

Response

Success

Example response

{
  "data": {
    "type": "job-roles",
    "id": "RoleID123",
    "attributes": {
      "role-id": "RoleID123",
      "name": "Product Designer",
      "description": "Product Designer role",
      "data": [
        {
          "type": "skills",
          "id": "Prototyping",
          "meta": {
            "target-level": 4,
            "priority": 1
          }
        }
      ]
    }
  }
}