diff --git a/docs/index.md b/docs/index.md index 315b90532..f0da9f125 100644 --- a/docs/index.md +++ b/docs/index.md @@ -124,7 +124,7 @@ GOV.UK Notify supports the following client libraries: These provide example code for calling the API and for creating API tokens. -### API endpoints +## API endpoints You can use the GOV.UK Notify API to: @@ -132,6 +132,9 @@ You can use the GOV.UK Notify API to: * [retrieve the status of one notification](#get_single_notif) * [retrieve the status of all notifications](#get_all_notif) + +### Send notifications + To send an sms notification: ``` @@ -192,6 +195,9 @@ The response (status code 201) will be: where `id` is the unique identifier for the notification – you'll use this id to retrieve the status of a notification. + +### Retrieve notifications + To retrieve the status of a single sms or email notification: ``` @@ -312,7 +318,7 @@ GET /notifications?&page=2 ``` -## Authorisation error messages +### Authorisation error messages Error code | Body | Meaning --- | --- | --- @@ -322,7 +328,7 @@ Error code | Body | Meaning 403 | {"result": "error", "message": "Invalid credentials"} | Unable to find Service ID that was sent in the iss claim, no valid API for Service ID 403 | {"result": "error", "message": "Invalid token: expired"} | Token is expired; there is a 30 second time limit -## Other error messages +### Other error messages Error code | Body | Meaning --- | --- | --- @@ -333,7 +339,7 @@ Error code | Body | Meaning -### GOV.UK Notify API code +## GOV.UK Notify API code The GOV.UK Notify API code is open sourced at: