Update a job category
Updates an existing job category, identified by its internal ID or an external reference.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/job-categories/{jobCategoryReference}
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-job-categories.write
URL parameters
| Parameter | Description |
|---|---|
{jobCategoryReference} |
The internal ID or external reference of the job category. |
Body properties
| Field | Type | Required | Writable | Description |
|---|---|---|---|---|
name.default |
string | Yes | Yes | Default name of the job category. |
name.translations |
object | No | Yes | Translated names, keyed by ISO language code (for example nl, fr). |
externalCode |
string | No | Yes | External code for the job category. Maximum 50 characters. |
External references
The endpoint resolves {jobCategoryReference} through the externalReferences query parameter. See the external references page for details.
| Collection | Predefined | Custom |
|---|---|---|
job-categories |
Not available | Supported |
Error responses
| Status | Condition |
|---|---|
400 |
Invalid external reference specification, or validation failed (missing name.default, invalid translation key, value too long) |
401 |
Missing or invalid access token, or insufficient scope |
404 |
Job category with the given ID or external reference not found |
Success response
200 OK. The response body is empty.
Examples
Update a job category by internal ID
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/job-categories/24
{
"name": {
"default": "White collar"
},
"externalCode": "JC-02"
}Update a job category by custom external reference
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/job-categories/JC-02?externalReferences=(job-categories,customJobCategoryCode)
{
"name": {
"default": "White collar"
}
}