darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-05-31 03:20:28 -04:00
Code Issues Packages Projects Releases Wiki Activity

Template ID in caps

Browse Source
This commit is contained in:
catherineheywood
2016-05-05 11:50:33 +01:00
parent 9bb1d7e021
commit 4597439fcd
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/index.md
View File

@@ -171,9 +171,9 @@ POST /notifications/email
where:
* `to` is a required string that indicates the recipient's phone number or email address
* `template` is a required string that indicates the template ID to use
* `template` is a required string that indicates the Template ID to use
**Note:** To access the template ID from the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web application, go to **Text message templates** or **Email templates** and click on **API info**.
**Note:** To access the Template ID from the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web application, go to **Text message templates** or **Email templates** and click on **API info**.
* `personalisation` is an optional array that specifies the placeholders and values in your templates
@@ -287,7 +287,7 @@ where:
* `status` is the status of the notification; this can be `sending`, `delivered`, or `failed`
* `to` is the recipient's phone number or email address
* `template`:
* `id` is the template ID
* `id` is the Template ID
* `name` is the name of the template used
* `template_type` is `sms` or `email`
* `created_at` is the full timestamp, in Coordinated Universal Time (UTC), at which GOV.UK Notify created the notification