View as Markdown

Errors

The ControlCom Connect API reports failures with standard HTTP status codes and a JSON body that says what went wrong. This page lists the codes you will meet and what each one means for your request.

Status Codes

A 2xx response means the request succeeded. Anything in the 4xx range means the request itself needs to change; 5xx means the platform failed to process a valid request, which is rare and worth reporting to support together with the request you sent.

StatusMeaning
400Validation failed. The body contains an errors array describing each invalid field.
401Missing or invalid credentials. Check the Authorization header and that the API key or token has not expired.
403The credentials are valid but lack a required permission. The body lists them in missingPermissions.
404The record does not exist in this organization, or the path is wrong.
409A uniqueness conflict, such as reusing a name that must be unique.

Error Body

Error responses carry a message and, depending on the failure, either an errors array (validation) or a missingPermissions array (authorization). A permission error looks like this:

Permission error

{
  "missingPermissions": ["CreateDevice"],
  "message": "Request failed to complete. Missing required permissions"
}

Permissions are granted per role in Team; an API key inherits the permissions of the role it was created with. Authentication itself is covered in API Reference: Authentication, and the API Reference overview repeats this table alongside pagination and request conventions.

Was this page helpful?