AutomatedEmailTemplates

Saves the clinic's subject and wording for one email. A blank field keeps the stock text for it; both blank is the same as Reset to default. Wording that uses a token the email can't fill is refused, naming the tokens.

Changed on
put/templates/automated-emails/{type}

Request

Path parameters

typestring required

Request body

emailSubjectstring nullable
emailBodystring nullable

Response

OK

typestring required
namestring required
descriptionstring required
defaultSubjectstring required
defaultBodystring required
variablesstring[] required

The tokens this email can use, in the order the editor offers them.

blockVariablesstring[] required

Tokens that must sit on a line of their own in the body (a list, a button).

emailSubjectstring nullable
emailBodystring nullable
customisedboolean

True when the clinic has saved wording for this email.

updatedAtstring date-time nullable

Changes