From 56b50138737cb00af0273514923ba5f20aaa2538 Mon Sep 17 00:00:00 2001 From: catherineheywood Date: Tue, 3 May 2016 15:31:01 +0100 Subject: [PATCH] Indicate if string/array for parameters --- docs/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index f05bc017d..f9f205b11 100644 --- a/docs/index.md +++ b/docs/index.md @@ -163,12 +163,12 @@ POST /notifications/email where: -* `to` is the phone number or email address (required) -* `template` is the template ID to send (required) +* `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 send **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` (optional) specifies the values for the placeholders in your templates +* `personalisation` is an optional array that specifies the values for the placeholders in your templates **Note:** You must provide all placeholders set up in your template. See [how to create placeholders in a template](#quickstart). @@ -212,7 +212,7 @@ GET /notifications/{id} where: * `status` is the the status of the notification; this can be `sending`, `delivered`, or `failed` -* `to` is the phone number or email address +* `to` is the recipient's phone number or email address * `template_type` is `sms` or `email` * `sent_at` is the full timestamp, in Coordinated Universal Time (UTC), at which the notification was sent * `message` is the content of message