"Data Integrity Violation Error" when updating users through a REST API Call

Question

Why do I get the following Data Integrity Violation Error when I try to update a user using the xMatters REST API:

Could not create user. Returned error: Data Integrity Violation Error.

Environment

All versions of xMatters

Answer

This error occurs when one or more values you are sending to xMatters violates a data constraint on the platform (for example, a field length limit).

For example, xMatters enforces a maximum size for certain identifier fields such as an Incident ID. If a flow or integration (for example, a Flow Designer Create Alert step that also creates or updates a user or related record) sends an Incident ID value that is longer than the allowed limit (such as 400 characters when the platform maximum is 250), xMatters will return a 409 Data Integrity Violation Error and fail to create the associated form and alert.

To resolve the issue, review the payload you are sending (or the columns in your User Upload file) and make sure all text fields, including identifiers like Incident ID, are within the platform's documented length limits before resubmitting the request.