Templates

Creates a template from a starter layout. The copy is the clinic's own — it is never made the default automatically, and later changes to the starter don't touch it. The name gets a " (2)", " (3)"… suffix if the clinic already has one by that name.

Changed on
post/templates/starters/{key}

Request

Path parameters

keystring required

Response

Created

idstring
namestring
typestring
logoUrlstring nullable
headerContentstring nullable

Legacy field - kept for backward compatibility.

footerContentstring nullable

Legacy field - kept for backward compatibility.

formatstring nullable
emailSubjectstring nullable
emailBodystring nullable
smsBodystring nullable
categorystring nullable

Client-message category key (type "client-message" only, ITE-1170).

channelstring nullable

Client-message channel: "email", "sms" or "both" (type "client-message" only).

isDefaultboolean
archivedAtstring date-time nullable

When the template was archived; null while active.

createdByIdstring nullable
createdAtstring date-time
updatedAtstring date-time
unknownVariablesstring[] nullable

Set on create/update responses only: {{tokens}} in the saved sections that the render pipeline will not substitute for this template's type (typos or variables from another template type). Null when everything is known or validation was not run.

Changes

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      endpoint added