Skip to main content

RESTResponse

statusstring

Possible values: [OK, FAIL, ERROR]

codestringnullable

ResultCode enum name (e.g. SUCCESS, NOT_FOUND, RATE_LIMIT_EXCEEDED)

messagestringnullable

Error message, present when status is FAIL or ERROR.

messagesstring[]nullable

In rare, specific cases, additional error messages.

data

Operation result payload. Its shape is specific to each endpoint and is shown in that endpoint's response schema.

requestIdstringnullable
RESTResponse
{
"status": "OK",
"code": "string",
"message": "string",
"messages": [
"string"
],
"requestId": "string"
}