Error handling

How Toggle returns error responses

Toggle returns descriptive messages for any returned errors (as opposed to error codes or numbers).

For this reason, we recommend that you shouldn't try to re-interpret error strings to your own UI, and instead use them verbatim.

Here's an example error response:

{
  "errors": [
    {
      "message": "validation",
      "locations": [
        {
          "line": 2,
          "column": 29
        }
      ],
      "validation": {
        "currency": [
          "This field is required"
        ]
      },
      "customer_facing": false
    }
  ],
  "data": {
    "createBalanceAdjustment": null
  }
}