Invalid payload

An invalid payload error indicates that the request body is malformed or fails JSON Schema validation.

This error requires you to correct the request before retrying. Common causes include missing required fields, properties with incorrect types, or values that do not match their constraints.

Response

All error responses follow the Problem Details (RFC 9457) format, which defines the type, title, status, detail, and instance fields.

Here is an example of the response returned for this error:

{  "type": "https://croct.help/api/event-tracking/invalid-payload",  "title": "The event is invalid.",  "status": 400,  "detail": "Some of the request parameters are invalid.",  "violations": [    {      "path": "/payload/type",      "reason": "The property \"type\" is missing."    }  ]}

The response includes the following additional field:

violations(optional)

Array<object>

The list of individual validation failures.

path(optional)

string

A JSON pointer to the invalid field.

reason

string

A human-readable explanation of the constraint that was violated.