Skip to content

CCM-10161: Added new global routing config to API docs #939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tdroza-nhs merged 1 commit into from
May 19, 2025
Merged

CCM-10161: Added new global routing config to API docs #939

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions specification/documentation/APIDescription.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,11 +153,12 @@ You'll then need to include this personalisation field in your request.
### Making your request to send messages from your software
Use the following routing plan IDs and personalisation fields that match the message channel your user will send their message with.

| Message channel | Personalisation field | Routing plan ID |
|-----------------|----------------------------|--------------------------------------|
| NHS App message | body | 00000000-0000-0000-0000-000000000001 |
| Email | email_subject, email_body | 00000000-0000-0000-0000-000000000002 |
| Text message | sms_body | 00000000-0000-0000-0000-000000000003 |
| Message channel | Personalisation field | Routing plan ID |
|------------------------------------------|----------------------------------------|--------------------------------------|
| NHS App message | body | 00000000-0000-0000-0000-000000000001 |
| Email | email_subject, email_body | 00000000-0000-0000-0000-000000000002 |
| Text message | sms_body | 00000000-0000-0000-0000-000000000003 |
| NHS App message with a fallback to email | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000004 |

For email, use the personalisation field `email_subject` to allow your user to add the email subject line.

Expand Down