Update

Update Job Title

POST - /v2/companies/<company_id>/job-titles/<job_title_id>

📘

Valid Update Properties

All properties outlined in the Job Titles - Create page are valid properties to send across the Job Title update endpoint except those listed below for which there are additional endpoints. It is only necessary to send key/val pairs for properties that are being updated. No need to send values for properties that aren't being changed.

Properties with special endpoints:

• group_ids - Add, Remove

Responses:

Successful Response

Upon successfully updating a Job Title you will receive back an entire copy of the updated Job Title object.

Updated Job Title

{
  "id": "2d2ad78e-c6de-467e-8413-c616b55294a5",
  "name": "Foreman",
  "group_ids": [],
  "globally_accessible": true,
  "color": "#53A9FF",
  "type": "hourly",
  "hourly_rate": 45
}

Make Job Title available to Group

POST - /v2/companies/<company_id>/job-titles/<job_title_id>/groups

To make a Job Title available to a Group it was not previously, hit the above endpoint with a POST body specifying the new Group ID you would like added.

Group ID Body

{"group_id": "ea8fac53-e05f-49bc-a630-dd0c7739570b"}

Responses:

Successful Response

After successfully making a Job Title available to a new Group, you will receive back an array of all the Group IDs the Job Title is now available to as confirmation.

Job Title's Group IDs

{
  "group_ids": [
    "bc107873-b2fe-4f8f-9879-6d95b4a0684f",
    "2d2ad78e-c6de-467e-8413-c616b55294a5",
    "ea8fac53-e05f-49bc-a630-dd0c7739570b"
  ]
}

Remove Job Title from being available to Group

DELETE - /v2/companies/<company_id>/job-titles/<job_title_id>/groups

To remove a Job Title from being available to a Group it was previously available to, hit the above endpoint with a DELETE body specifying the Group ID you would like removed.

Group ID Body

{"group_id": "ea8fac53-e05f-49bc-a630-dd0c7739570b"}

Responses:

Successful Response

After successfully removing a Job Title from being available to a Group, you will receive back an array of all the Group IDs the Job Title is now available to as confirmation.

Job Title's Group IDs

{
  "group_ids": [
    "bc107873-b2fe-4f8f-9879-6d95b4a0684f",
    "2d2ad78e-c6de-467e-8413-c616b55294a5"
  ]
}