API

All endpoints are on the university's own address, e.g. https://<university>.<platform domain>, and need a logged-in user. Each call only returns and changes what the user's roles allow (roles).

Entity	Endpoint
Brand Asset	/api/omnichannel/brand_asset
Email Campaign	/api/omnichannel/campaign
Channel	/api/omnichannel/channel
Delivery Event	/api/omnichannel/delivery_event
Message Log	/api/omnichannel/message
Portal	/api/omnichannel/portal
Sending Provider	/api/omnichannel/provider
Suppression	/api/omnichannel/suppression
Message Template	/api/omnichannel/template
Template Attachment	/api/omnichannel/template_attachment
Template Version	/api/omnichannel/template_version
Unsubscribe Group	/api/omnichannel/unsubscribe_group
Daily Usage	/api/omnichannel/usage_daily

Events

Direction	Event
emits	omnichannel.message.delivered
emits	omnichannel.message.failed
emits	omnichannel.campaign.completed
emits	omnichannel.suppression.created

Settings

Each university sets these from its admin screen.

Setting	Type	Default	Label
devMode	check	true	Test mode: send only to the test recipients below
testRecipients	text	""	Test mode recipients (comma-separated emails or numbers)
defaultFromEmail	text	""	Default sender email address
defaultReplyTo	text	""	Default reply-to email address
trackOpens	check	true	Track email opens by default
trackClicks	check	true	Track link clicks by default
unsubscribeFooter	check	true	Add an unsubscribe footer to campaign emails
campaignChunkSize	number	100	Campaign emails sent per batch
retryDeferredHours	number	24	Keep retrying a deferred send for (hours)