Null values

In PUT and POST requests, do not set any fields unless you have a reason to do so. As a base rule you don't need to set strings to null or empty string, numbers to 0 etc. - doing so can and will cause unintended consequences or errors.

Updating values

Updates to existing records can be made using PUT calls to the correct endpoints. All PUT actions perform partial updates of the records. Only those fields that are explicitly in the call body are modified, all others fields are left unchanged.

Required fields

In POST operations, request schema fields marked as required mean that the field has to be included in the request. If the field is missing you will receive a HTTP 422 Unprocessable Entity response code.

Fields in the response schema for a GET request that are marked as required indicate that those fields will always have a value in the returned response message. This means that you as an integrator can rely on the value being set when processing the response.