Errors

When a request fails, the API answers with a status code and a JSON body with an error field.

{
  "error": "invalid api key"
}

The status code tells you what kind of failure it was. The error text gives the reason. Some are fixed codes that are safe to check for in your code, listed below. Others are plain sentences and may change.

Status codes

Status	Meaning
`400`	The request is malformed or a value isn't valid. Check the fields you sent.
`401`	The API key is unknown or revoked, or the room has an output password and you sent no key.
`403`	You sent no key, the key doesn't have access to this, or your plan doesn't include it.
`404`	The room or item doesn't exist.
`409`	The request conflicts with the room's current state. See below.

Error codes

Status	`error`	What to do
`401`	`invalid api key`	Check the key, or create a new one.
`401`	`password required`	Send your API key. Keys skip output passwords.
`403`	`plan_required`	Upgrade to a plan that includes this. All requests with a key from a Free team get this.
`409`	`plan_limit`	You've reached a limit of your plan. Remove something, or upgrade.
`409`	`archived`	The room is archived, so it can't be changed. Unarchive it from the dashboard.
`409`	`suspended`	The room is suspended, and only Kloksi can lift that.
`409`	`room_changed`	An import was prepared against an older version of the room. See Import timers.