zulip/templates/zerver/api/common-error-payloads.md

Sample payloads for common errors

Invalid API key

A typical failed JSON response for when the API key is invalid:

{generate_code_example|invalid-api-key|fixture}

Missing request argument(s)

A typical failed JSON response for when a required request argument is not supplied:

{generate_code_example|missing-request-argument-error|fixture}

User not authorized for query

A typical failed JSON response for when the user is not authorized for a query:

{generate_code_example|user-not-authorized-error|fixture}