messaging_templates

Make a template transactional

Changed on

Make this template sendable over the transactional email API. This creates the workflow that sends it, with its own metrics, run history and versions. This can't be undone: the template stays transactional. Transactional sends ignore marketing opt-outs. Calling it again on a transactional template changes nothing.

post/api/projects/{project_id}/messaging_templates/{id}/make_transactional/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/messaging_templates/{id}/make_transactional/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this message template.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

from_integration_idinteger nullable

ID of the verified email sender integration the email is sent from. Defaults to the project's default sender.

Response

The transactional template

idstring uuid required
namestring required

Human-readable template name shown in the library.

descriptionstring

What the template is for and when to use it.

tagsstring[]

Tags for organizing templates, for example by team or use case. Tags are shared with the rest of the project. Omit to keep the current tags, send an empty list to remove them all.

created_atstring date-time required
updated_atstring date-time required
typestring

Message channel of the template. Currently 'email'.

message_categorystring uuid nullable

Message category ID to file the template under. Must belong to the same project.

deletedboolean

Soft-delete flag. Set true to remove the template from the library.

sensitiveboolean

For emails that carry login codes, reset links or other secrets. PostHog keeps no copy of each sent email's body or filled-in subject, and clicked links keep only the site address. Can change at any time.

transactional_hog_flow_idstring uuid nullable required

The workflow that sends this template over the transactional email API. Null until the template is made transactional. Each content save writes a new version of it.

Changes