Request Response Clarity

Request Response Clarity

Clear, consistent error messages are a critical feature of good API products and are important pieces of a world-class developer experience. Error messages are critical at all phases of the API integration lifecycle:

• Exploration: Quickly finding issues during POCs, which builds trust in the API
• Integration: Rapid debugging of issues during integration, and building solid client-side error handling.
• Production: Fast triage and resolution of production issues.

Error message clarity is especially important for 400, 404, 405, and 5xx errors, as those errors often require code changes or operational responses. Please ensure that all of these errors have unambiguous explanations with at least one suggested method for correcting the error.

It is recommended that error messages are vetted by non-technical personnel, such as technical writers, product managers, and sales engineers for clarity and readability.