Providing your own data - Personalising your messages

Your developer or technical team should include data for your custom personalisation fields in your API or MESH request.

If you use NHS Notify API

Include a personalisation block for each message in your API request.

For example, if you want to include ((gpSurgery)) and ((appointmentDate)) as custom personalisation fields, the personalisation block for one message will be:

personalisation: {
"gpSurgery": "The Health Centre, Knaresborough Road",
"appointmentDate": "15 January 2027"
}

To find out where to add this in your request, go to NHS Notify API (opens in a new tab).

If you use NHS Notify MESH

Include the custom personalisation fields as column headings in the CSV file you use in your request. Put the personalisation data for each message in the rows underneath, with one row per message.

The column heading should start with personalisation_ followed by the same wording as the personalisation field in your template.

For example, if your personalisation fields are ((gpSurgery)) and ((appointmentDate)), the column headings will be:

personalisation_gpSurgery personalisation_appointmentDate

The CSV file you use in your MESH request is different to the CSV example data file for custom personalisation fields.