Invalid payload

Resolve invalid payload errors.

The request body is well-formed but fails schema or semantic 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. The type, title, status, and detail fields are always present, while instance may be omitted depending on the API.

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

{  "type": "https://croct.help/api/general/invalid-payload",  "title": "Invalid payload.",  "status": 422,  "detail": "Some of the request parameters are invalid.",  "violations": [    {      "path": "/payload/type",      "reason": "The object must have a property whose name is \"type\"."    }  ]}

The response includes the following additional field:

violations
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.