Control Panel — API documentation

Handling Errors

When errors occur in a request the response will contain the "errors" array. Structured error objects will be given describing what changes need to be made before the request should be made again. The error object is broken down into 4 fields: status, code, title, and details.

{
	"errors":
	[
		{
			"status": 400,
			"code": "REQUIRED_FIELD",
			"title": "Missing one or more required fields",
			"detail": "Stream is a required field"
		}
	]
}
Status

The HTTP status code returned by this error.

Code

The unique ID for this error.

Title

Generic information about this error type.

Detail

Specifc message relating to the field or parameter that caused the error and reason why the error occured.

Objects have their own unique validation rules. To see the object specific errors view the "Errors" section on the object's documentation page.

General Error

ACCESS_VIOLATION

You do not have access to modify this field.

REQUIRED_FIELD

Missing one or more required fields

METHOD_NOT_ALLOWED

Method has been disabled on objects of this type. This is returned when trying to Perform PUT, POST, or DELETE on endpoints that do not support it.

NOT_FOUND

An object could not be found with that ID.

REQUEST_UNSUPPORTED

A HTTP request has been made that the server does not support.

REQUEST_INVALID

A request has been made that the server does not recognize.

Data Type Errors

TYPE_MISMATCH

Data type does not conform to required field type.

MAX_LENGTH_EXCEEDED

The value exceeded maximum length allowed.

INVALID_ENUM

The value does not match one of the predefined values.

INVALID_RANGE

TThe value is outside of defined range.