Update a department
Updates an existing department, 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/departments/{departmentReference}
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-departments.write
URL parameters
| Parameter | Description |
|---|---|
{departmentReference} |
The internal ID or external reference of the department. |
Body properties
| Field | Type | Required | Writable | Description |
|---|---|---|---|---|
name.default |
string | Yes | Yes | Default name of the department. |
name.translations |
object | No | Yes | Translated names, keyed by ISO language code (for example nl, fr). |
externalCode |
string | No | Yes | External code for the department. Maximum 50 characters. |
External references
The endpoint resolves {departmentReference} through the externalReferences query parameter. See the external references page for details.
| Collection | Predefined | Custom |
|---|---|---|
departments |
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 |
Department with the given ID or external reference not found |
Success response
200 OK. The response body is empty.
Examples
Update a department by internal ID
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/departments/456
{
"name": {
"default": "Production East"
},
"externalCode": "PROD-01"
}Update a department by custom external reference
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/departments/PROD-01?externalReferences=(departments,customDepartmentCode)
{
"name": {
"default": "Production East",
"translations": {
"nl": "Productie Oost"
}
}
}