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: docs/pages/using-nhs-notify/personalisation.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,13 +15,16 @@ You can send personalised messages using a single template.
15
15
To personalise a message, use double brackets to add a placeholder to your content. For example:
16
16
17
17
{% include components/inset-text.html
18
-
text='<code>Hello ((firstName)), your NHS Number is ((nhsNumber))'
18
+
text='Hello ((firstName)), your NHS Number is ((nhsNumber))'
19
19
%}
20
20
21
+
## Personal Demographics Service (PDS) personalisation fields
21
22
## Personal Demographics Service (PDS) personalisation fields
22
23
24
+
NHS Notify uses the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service) to find and populate certain personalisation fields for each recipient. This happens automatically when you [tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}) using recipients' NHS numbers.
23
25
NHS Notify uses the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service) to find and populate certain personalisation fields for each recipient. This happens automatically when you [tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}) using recipients' NHS numbers.
24
26
27
+
You can use the following PDS personalisation fields in your templates:
25
28
You can use the following PDS personalisation fields in your templates:
26
29
27
30
- fullName
@@ -33,6 +36,7 @@ You can use the following PDS personalisation fields in your templates:
33
36
- nhsNumber
34
37
- date
35
38
39
+
Any placeholders in your content need to match the PDS personalisation fields.
36
40
Any placeholders in your content need to match the PDS personalisation fields.
37
41
38
42
## Providing your own personalisation data
@@ -41,30 +45,30 @@ You can provide your own personalisation data.
41
45
42
46
Do not send us personalisation data that's already available in PDS. We'll use the PDS data over your own data in this case.
43
47
48
+
### If you're using NHS Notify API
44
49
### If you're using NHS Notify API
45
50
46
51
Include a personalisation block in your API request.
47
52
48
53
For example, if you wanted to include 'practice' as a personalisation field, the personalisation block would be:
49
54
50
55
{% include components/inset-text.html
51
-
text='{
52
-
53
-
"practice": "PRACTICE_NAME",
54
-
55
-
}'
56
+
text='"practice": "PRACTICE_NAME",'
56
57
%}
57
58
58
59
Read the [API documentation](https://digital.nhs.uk/developer/api-catalogue/nhs-notify#post-/v1/message-batches) to find out where to put this in your request.
59
60
61
+
### If you're using NHS Notify MESH
60
62
### If you're using NHS Notify MESH
61
63
62
64
Include the personalisation fields as columns in your CSV file.
63
65
66
+
The column names should start with 'personalisation\_', followed by the same wording as the placeholders in your template.
64
67
The column names should start with 'personalisation\_', followed by the same wording as the placeholders in your template.
65
68
66
69
For example, if you wanted to include 'practice' as a personalisation field, the column name would be:
0 commit comments