For the correct integration of your external systems with Humand, through our API, it is essential to understand how to use it correctly. This ensures that everything works smoothly.
How to use the PATCH method?
The PATCH method is used to partially update an object's attributes. In other words, it is used to update certain attributes of a particular object:
The object attributes that can be updated depend on the object. For example, the attributes of User that can be partially updated are
- firstName
- lastName
- nickname
- profile-field
- relationships
- fields
- phoneNumber
- hiringDate
- birthdate
- segmentations (Regarding partial segmentation updates via the endpoint /users/{employeeInternalId}/segmentations, we would like to inform you that it assigns users only the items that are sent (regardless of items from other segments), which allows segmentation information to be sent through the integration and other manual segments to be managed from Admins).
How to user the PUT method?
The PUT method is used to update or completely replace an object. In other words, it is used to replace the entire object.
The objects available in our API that can be updated with PUT are:
- user
- segmentation
- article
- products
You can learn about all objects and their attributes from Humand Public API