ErrorResponse

Response envelope on error (accept: false).

datanullable

The endpoint payload (the DTO documented per endpoint).

messagestring

Human-readable status. "Success" on success.

Example: Success

error objectnullable

Present only on error responses.

messageCodeint32

Numeric error code — see the Error Codes appendix.

Example: 3705

args object

Additional context placeholders (key-value).

property name*any

Additional context placeholders (key-value).

Example: {"&name&":"VIP"}

acceptboolean

true on success, false on error.

Example: false

errors object[]

Field-level validation errors (empty on success).

Array [

fieldstring

Name of the offending field

Example: pipeStatusId

reasonReason

Validation failure reason enum.

Possible values: [DECIMAL_MIN, DECIMAL_MAX, MIN, MAX, CONFLICT, NOT_NULL, NOT_EMPTY, NOT_FOUND, NOT_BLANK, LENGTH, SIZE, NOT_NULL_COLLECTION, VALID_PHONE, NULLABLE_NOT_EMPTY, VALID_EPOCH_SEC]

Example: NOT_NULL

]

requestIdstringnullable

Set for asynchronous write endpoints.

Example: null

ErrorResponse

{
  "message": "Success",
  "error": {
    "messageCode": 3705,
    "args": {
      "&name&": "VIP"
    }
  },
  "accept": false,
  "errors": [
    {
      "field": "pipeStatusId",
      "reason": "NOT_NULL"
    }
  ],
  "requestId": null
}