Create Message

POST /v2/partner/messages

Required scopes

partner:messages:write

Tokens missing any required scope return 401 scope_missing. See Auth & Scopes for issuance.

Operation

Operation ID	`createMessage`
Tags	Campaigns

Request body

Required

object

Field	Type	Description
id *	id	UUID v4.
type *	enum (1)	`message`
template_id *	id	UUID v4.
channel *	enum (3)	`emailsmspush`
name *	string
subject	string
preview_text	string
from_name	string
from_address	string
reply_to	string
body_html	string
body_plain	string
push_title	string
push_body	string
send_offset_hours *	number
is_archived *	boolean
is_active *	boolean
inserted_at *	updated_at	RFC 3339 / ISO 8601 timestamp.
updated_at *	updated_at	RFC 3339 / ISO 8601 timestamp.

Responses

201

Created

object

Field	Type	Description
id *	id	UUID v4.
type *	enum (1)	`message`
template_id *	id	UUID v4.
channel *	enum (3)	`emailsmspush`
name *	string
subject	string
preview_text	string
from_name	string
from_address	string
reply_to	string
body_html	string
body_plain	string
push_title	string
push_body	string
send_offset_hours *	number
is_archived *	boolean
is_active *	boolean
inserted_at *	updated_at	RFC 3339 / ISO 8601 timestamp.
updated_at *	updated_at	RFC 3339 / ISO 8601 timestamp.

Example request

POST https://api.digitalonboarding.com/v2/partner/messages
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>

{ /* request body matching schema above */ }