API Error Handling

The Highnote API rejects invalid queries and populates error information in the errors array. These errors are similar to compile-time errors and can be triggered if you send an invalid type or miss a required field.

Invalid queries return a 400 Bad Request error response with the following body:

Copy code snippet

We recommend testing requests and queries in the test environment before using them in your live environment. After testing in the test environment, you should see very few errors.

The Highnote API uses the errors as data pattern for validation and logic errors.

Using data (instead of errors) lets Highnote document and tailor what is returned to your system. Invalid input errors are represented as data in the UserError type that is part of the returned union type. All mutations have the UserError type on the union that you can select and query for errors.

The Highnote API includes a requestId field with a unique identifier for each request.

The request ID is especially useful when you need help with a response. Ensure you log this ID on any errors you encounter so the Highnote support team can monitor and debug your request.

The requestId field can be found in the extensions key of the response:

Copy code snippet