Skip to main content

OperationStatusResponse

The generic success/error envelope returned by mutating endpoints. status is "success" | "error"; message and field are present only on error. A business failure is a 200 body with no code.

statusstringrequired

"success" or "error".

messagestring

Text for display when status is "error".

fieldstring

JSON name of the request property at fault, when known.

OperationStatusResponse
{
"status": "string",
"message": "string",
"field": "string"
}