Status Codes

The Status Codes widget documents the HTTP status codes your API returns, so readers know what each response means.

1. Insert the widget: on a new line, type /status codes and select the Status Codes widget.
2. Add status codes: click Add for each code your API uses, providing:
   • The status code number (e.g. 200, 400, 404)
   • A brief title (e.g. OK, Bad Request, Not Found)
   • A clear description of when it's returned and what it signifies
3. Use the library: as you type a code, Theneo suggests existing status codes for consistency and accuracy.
4. Organize and edit: reorder codes with the up/down arrows, or delete entries with the trash icon.
5. Be complete: document all the codes your API returns, both success and error, for comprehensive documentation.