Join BoxWorks 2024 to discover what's possible with content and AI!

Client error

A generic error

type string

exampleerror

error

Value is always error

code string

exampleitem_name_invalid

A Box-specific error code

Value is one of created,accepted,no_content,redirect,not_modified,bad_request,unauthorized,forbidden,not_found,method_not_allowed,conflict,precondition_failed,too_many_requests,internal_server_error,unavailable,item_name_invalid,insufficient_scope

context_info associative array

A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. message is only one example.

context_info.<key> object

help_url string

examplehttps://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/

A URL that links to more information about why this error occurred.

message string

exampleMethod Not Allowed

A short message describing the error.

request_id string

exampleabcdef123456

A unique identifier for this response, which can be used when contacting Box support.

status integer (int32)

example400

The HTTP status of the response.

Response Example

{
  "type": "error",
  "code": "item_name_invalid",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "message": "Method Not Allowed",
  "request_id": "abcdef123456",
  "status": 400
}