Create a work location

Create a work location

Creates a new work location.

Tip

Check the Swagger page for more technical information on the endpoints.

Endpoint details

POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-locations

Headers: Authorization: Bearer {token}, User-Agent: {agent} Scope: connector-protimeapi-work-locations.write

Body properties

Field Type Required Writable Description
name.default string Yes Yes Default name of the work location.
name.translations object No Yes Translated names, keyed by ISO language code (for example nl, fr).
description string No Yes Free-text description of the work location.

External references

This endpoint does not accept the externalReferences query parameter. Register a custom external reference for the created work location with the external references endpoints.

Error responses

Status Condition
400 Validation failed (missing name.default, invalid translation key)
401 Missing or invalid access token, or insufficient scope

Success response

201 Created with a Location header pointing to the new work location. The response body is empty.

Examples

Create a work location

POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-locations

{
  "name": {
    "default": "Home office"
  },
  "description": "Work performed from the employee's home address."
}

Related pages