Guidelines
Guidelines and conventions
In general, missing fields in a POST request will be treated as a NULL value, and wipe data for the corresponding field. This means that all POST requests, including updates, should contain complete data. Missing / empty JSON arrays will also generally delete all data previously contained in the list. The general exception to this rule is when the objects in the list have their own primary ID. In practice this means that you should retrieve the full object from our REST service, make the wanted changes to the object, and save the object again.
Dates
Dates are formatted as ISO 8601.
| Date format examples | |
|---|---|
| Date | 2023-07-25 |
| Date and time in UTC | 2023-07-25T05:55:26Z |
| Date and time UTC+2 | 2023-07-25T12:55:26+02:00 |
API User
For most, if not all, integration purposes, it is advisable to use a dedicated API user. The only exception is if you need to execute requests within your own user session, for instance, to implement click-to-call functionality. For all other purposes, a dedicated API user should be utilized. This practice creates a clear separation of concerns and allows us to implement better access control.
ITX support will assist you in creating an API user suitable for your integration needs.