CLclinicos
Templates

Archives a client-message template: it leaves lists (unless `includeArchived=true`) but the row stays so its history survives. Undo with restore. Other types are refused — their send and print paths (and settings pages) don't know about archiving.

Changed on
post/templates/{id}/archive

Request

Path parameters

idstring required

Response

OK

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