Last updated 3 weeks ago

Custom Properties

After you've created the set of Employees & added the corresponding Custom Property Definitions, you can start adding the values for the specific custom properties.

You can choose between replacing all the custom properties of an Employee (via PUT), or only a subset of them (via PATCH).


For example, to indicate that a specific Employee is a freelancer, you can submit a PATCH request to the employees/<ID>/custom_properties/ endpoint:

        "property_name": "freelancer",
        "property_value": true

If you had used PUT for this request, all the attributes that are not in the request body are automatically deleted.

All custom properties of an Employee can be retrieved via submitting a GET request the employees/<ID>/custom_properties/ endpoint.