Skip to content

Commit dde0bab

Browse files
author
Leo Hemsted
committed
bring error sections in line with python docs
note that one section was completely removed - the "get all templates" endpoint does not have any errors listed at all in the python docs.
1 parent 59bb356 commit dde0bab

File tree

1 file changed

+3
-25
lines changed

1 file changed

+3
-25
lines changed

source/documentation/_api_docs.md

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1007,10 +1007,8 @@ If the request is not successful, the API returns `json` containing the relevant
10071007
10081008
|status_code|Error message|How to fix|
10091009
|:---|:---|:---|
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)|
10141012
10151013
### Email status descriptions
10161014
@@ -1233,7 +1231,7 @@ If the request is not successful, the API returns `json` containing the relevant
12331231
|:---|:---|:---|
12341232
|`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
12351233
|`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)|
12371235
12381236
12391237
### Get all templates
@@ -1290,26 +1288,6 @@ If no templates exist for a template type or there no templates for a service, t
12901288
}
12911289
```
12921290
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|
1312-
13131291
### Generate a preview template
13141292
13151293
#### Method

0 commit comments

Comments
 (0)