Skip to main content
POST
Create a journey message template

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json
name
string
required

Template label; nonblank after trimming.

Maximum string length: 120
Example:

"Welcome message"

body
string
required

Nonblank email HTML or SMS message; embedded stories require current publication permission and evidence.

Example:

"Hello {{first_name}}"

channel
enum<string>
required

Message channel.

Available options:
email,
sms
Example:

"email"

subject
string | null

Email subject; required and nonblank by the service for email templates.

Maximum string length: 255
Example:

"Welcome"

impact_story_ids
integer[]
Maximum array length: 25

Distinct approved story ID for SMS evidence.

Required range: x >= 1
design
any | null

Email designer document as JSON or a serialized string; nullable.

editor_mode
string | null

Accepted editor mode hint; actual mode follows channel.

Maximum string length: 32
Example:

"email"

entity_type
enum<string> | null

Journey subject type; sponsorship availability follows the workspace lifecycle feature flag.

Available options:
donor,
trip_participant,
entity,
sponsorship,
null
Example:

"donor"

Response

Create a journey message template completed.

data
object