Portal Docs v4

Staff

Marketing

How a message reaches a segment of patients, with its reach stated before anything is sent.

Access

How a member of staff reaches the screen, and what has to be true for it to open.

Element What it decides Permissions
Navigation Side menu → Marketing. Client:marketingMe:campaigns.access

Header

What the band states before anything below it is actionable.

Element What it decides Permissions
Title “Marketing”, with the number of live campaigns. —

Main actions

What belongs to the page rather than to one campaign.

Element What it decides Permissions
New campaign Opens the new campaign. Me:campaigns.create
Send Confirmed against the reach figure; never from the list. Me:campaigns.send

Form · New campaign

What a campaign needs, asked in an order where each answer narrows the next.

Field Validations Permissions
Channel Required. Email or SMS. —
Audience Required. A segment of patients, with its reach stated beside it. —
Content Required. Checked against the channel's length limit. —
Schedule Optional. Left empty, the campaign waits to be sent by hand. —

Filters

Which campaigns the list holds.

Element What it decides Permissions
Status Draft · Scheduled · Sent · Archived. —
Channel Email · SMS. —
Search Finds campaigns by name. —
View Cards or table — a way of looking, not a filter. —

Table

What one campaign shows in a row.

Element What it decides Permissions
Campaign The campaign's name. —
Channel Email or SMS. —
Audience The segment it goes to. —
Reach How many patients the audience matches, worked out again whenever it changes. —
Status Draft · Scheduled · Sent · Archived. —
Sent When it went out. —

Row actions

What can be done to one campaign.

Element What it decides Permissions
View The campaign with its reach broken down and its delivery figures. —
Duplicate Copies content and audience into a new draft. —
Archive Asks to confirm. Set apart at the end; a sent campaign is archived, never deleted. —

Errors

Not yet written from the code.

API calls

Not yet written from the code.