Skip to main content
POST
/
comms
/
v1
/
api
/
comms
/
template
Create or upsert a stored template.
curl --request POST \
  --url https://api.qflowhub.io/comms/v1/api/comms/template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '
{
  "eventId": "<string>",
  "name": "<string>",
  "html": "<string>",
  "id": "<string>",
  "subject": "<string>",
  "fromAddress": "<string>",
  "fromName": "<string>",
  "replyTo": "<string>",
  "attachPdf": true
}
'
{
  "id": "<string>",
  "eventId": "<string>",
  "name": "<string>",
  "subject": "<string>",
  "html": "<string>",
  "fromAddress": "<string>",
  "fromName": "<string>",
  "replyTo": "<string>",
  "attachPdf": true,
  "created": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.qflowhub.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 access token issued by https://identity.qflowhub.io/core. Include as Authorization: Bearer <token>. See the Authentication guide for the token flow.

​
Ocp-Apim-Subscription-Key
string
header
required

Your APIM subscription key. Sent in the welcome email when your account is enabled. Required on every request alongside the bearer token.

Body

Request body for POST /api/comms/template (create a stored invitation template that POST /api/guest can later reference via CommsTemplateId).

​
eventId
string
required

The event this template belongs to. Required.

​
name
string
required

Internal name of the template (shown in admin lists). Required.

​
html
string
required

The full HTML body. Merge tokens supported — see the merge-token reference.

​
id
string

Optional GUID — supply your own to make the create call idempotent (a duplicate POST with the same Id returns the existing template). Leave null and the server will generate one.

​
subject
string

Email subject line. Supports merge tokens (e.g. {{firstname}}).

​
fromAddress
string

Optional. Override the From address for sends from this template.

​
fromName
string

Optional. Override the From-Name (sender name) for sends from this template.

​
replyTo
string

Optional. Override the Reply-To address for sends from this template.

​
attachPdf
boolean

When true, every send made from this template attaches a PDF rendered from the same merge-resolved HTML the email body uses. Filename is {template-name}.pdf. PDF rendering adds ~1–2s latency per send; pace bulk flushes accordingly. Default false.

Response

OK

Response shape for GET/POST /api/comms/template[s].

​
id
string
​
eventId
string
​
name
string
​
subject
string
​
html
string
​
fromAddress
string
​
fromName
string
​
replyTo
string
​
attachPdf
boolean
​
created
string<date-time>