Object and fields

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, schema fields marked as required means that the field needs to be included in the request. If the field is missing you will receive an HTTP 422 Unprocessable Entity response.

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.