You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/documentation/_api_docs.md
+3-25Lines changed: 3 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -1007,10 +1007,8 @@ If the request is not successful, the API returns `json` containing the relevant
1007
1007
1008
1008
|status_code|Error message|How to fix|
1009
1009
|:---|:---|:---|
1010
-
|`400`|`[{`<br>`"error":"ValidationError",`<br>`"message":"id is not a valid UUID"`<br>`}]`|Check the notification ID|
1011
-
|`403`|`[{`<br>`"error":"AuthError",`<br>`"message":"Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
1012
-
|`403`|`[{`<br>`"error":"AuthError",`<br>`"message":"Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
1013
-
|`404`|`[{`<br>`"error":"NoResultFound",`<br>`"message":"No result found"`<br>`}]`|Check the notification ID|
1010
+
|`400`|`[{`<br>`"error":"ValidationError",`<br>`"message":"status ‘elephant’ is not one of [cancelled, created, sending, sent, delivered, pending, failed, technical-failure, temporary-failure, permanent-failure, pending-virus-check, validation-failed, virus-scan-failed, returned-letter, accepted, received]"`<br>`}]`|Change the [status argument](#status-optional)|
1011
+
|`400`|`[{`<br>`"error":"ValidationError",`<br>`"message":"‘Apple’ is not one of [sms, email, letter]"`<br>`}]`|Change the [template_type argument](#template-type-optional)|
1014
1012
1015
1013
### Email status descriptions
1016
1014
@@ -1233,7 +1231,7 @@ If the request is not successful, the API returns `json` containing the relevant
1233
1231
|:---|:---|:---|
1234
1232
|`403`|`[{`<br>`"error":"AuthError",`<br>`"message":"Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
1235
1233
|`403`|`[{`<br>`"error":"AuthError",`<br>`"message":"Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
1236
-
|`404`|`[{`<br>`"error":"NoResultFound",`<br>`"message":"No result Found"`<br>`}]`|Check your [template ID](#get-a-template-by-id-and-version-arguments-template-id-required) and [version](#version-required)|
1234
+
|`404`|`[{`<br>`"error":"NoResultFound",`<br>`"message":"No result found"`<br>`}]`|Check your [template ID](#get-a-template-by-id-and-version-arguments-template-id-required) and [version](#version-required)|
1237
1235
1238
1236
1239
1237
### Get all templates
@@ -1290,26 +1288,6 @@ If no templates exist for a template type or there no templates for a service, t
1290
1288
}
1291
1289
```
1292
1290
1293
-
#### Error codes
1294
-
1295
-
If the request is not successful, the API returns `json` containing the relevant error code. For example:
1296
-
1297
-
```javascript
1298
-
{
1299
-
"status_code":400,
1300
-
"errors": [
1301
-
{"error":"ValidationError", "message":"type blah is not one of [sms, email, letter, broadcast]"}
1302
-
]
1303
-
}
1304
-
```
1305
-
1306
-
|error.status_code|error.message|Notes|
1307
-
|:---|:---|:---|
1308
-
|`400`|`[{`<br>`"error":"ValidationError",`<br>`"message":"type <TYPE> is not one of [sms, email, letter, broadcast]"`<br>`}]`|Make sure that the provided `type` is one of: email, sms, letter |
1309
-
|`400`|`[{`<br>`"error":"NoResultFound",`<br>`"message":"No result found"`<br>`}]`|Check the [template ID](#generate-a-preview-template-arguments-template-id-required)|
1310
-
|`403`|`[{`<br>`"error":"AuthError",`<br>`"message":"Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
1311
-
|`403`|`[{`<br>`"error":"AuthError",`<br>`"message":"Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
0 commit comments