/

Back to MB Suite

Menu

API reference

Email Marketing

50 operations

Flows

GET/v1/email-marketing/flowsList email flows GET/v1/email-marketing/flows/{flow_id}Get one email flow with its steps POST/v1/email-marketing/flowsCreate an email flow PATCH/v1/email-marketing/flows/{flow_id}Update an email flow's settings POST/v1/email-marketing/flows/{flow_id}/duplicateDuplicate an email flow POST/v1/email-marketing/flows/{flow_id}/activateActivate an email flow POST/v1/email-marketing/flows/{flow_id}/pausePause an email flow POST/v1/email-marketing/flows/{flow_id}/archiveArchive an email flow DELETE/v1/email-marketing/flows/{flow_id}Delete an email flow POST/v1/email-marketing/flows/{flow_id}/stepsAdd a step to an email flow PATCH/v1/email-marketing/flows/{flow_id}/steps/{step_id}Update a step of an email flow DELETE/v1/email-marketing/flows/{flow_id}/steps/{step_id}Delete a step of an email flow POST/v1/email-marketing/flows/{flow_id}/steps/reorderReorder the steps of an email flow GET/v1/email-marketing/flows/{flow_id}/enrollmentsList the enrollments of an email flow POST/v1/email-marketing/flows/{flow_id}/enrollmentsEnroll one contact in an email flow POST/v1/email-marketing/flows/{flow_id}/enrollments/from-audienceEnroll an audience's current members in an email flow POST/v1/email-marketing/flow-enrollments/{enrollment_id}/exitTake a contact out of an email flow POST/v1/email-marketing/flows/{flow_id}/audiencesLink an audience to an email flow POST/v1/email-marketing/flows/{flow_id}/audiences/{audience_id}/unlinkUnlink an audience from an email flow

Campaigns

GET/v1/email-marketing/campaignsList email campaigns GET/v1/email-marketing/campaigns/{campaign_id}Get one email campaign POST/v1/email-marketing/campaignsCreate an email campaign draft PATCH/v1/email-marketing/campaigns/{campaign_id}Update an email campaign POST/v1/email-marketing/campaigns/{campaign_id}/duplicateDuplicate an email campaign POST/v1/email-marketing/campaigns/{campaign_id}/scheduleSchedule an email campaign POST/v1/email-marketing/campaigns/{campaign_id}/unscheduleUnschedule an email campaign (back to draft)POST/v1/email-marketing/campaigns/{campaign_id}/sendSend an email campaign now (real emails through Amazon SES)POST/v1/email-marketing/campaigns/{campaign_id}/cancelCancel an email campaign POST/v1/email-marketing/campaigns/{campaign_id}/archiveArchive or unarchive an email campaign DELETE/v1/email-marketing/campaigns/{campaign_id}Delete an email campaign POST/v1/email-marketing/campaigns/render-previewRender an email as recipients will see it

Audiences

GET/v1/email-marketing/audiencesList audiences GET/v1/email-marketing/audiences/{audience_id}Get one audience GET/v1/email-marketing/audiences/{audience_id}/membersList the people in an audience today POST/v1/email-marketing/audiencesCreate an audience PATCH/v1/email-marketing/audiences/{audience_id}Update an audience POST/v1/email-marketing/audiences/{audience_id}/refresh-countRecount an audience's members DELETE/v1/email-marketing/audiences/{audience_id}Delete an audience

Templates

GET/v1/email-marketing/templatesList email templates GET/v1/email-marketing/templates/{template_id}Get one email template POST/v1/email-marketing/templatesCreate an email template PATCH/v1/email-marketing/templates/{template_id}Update an email template POST/v1/email-marketing/templates/{template_id}/duplicateDuplicate an email template DELETE/v1/email-marketing/templates/{template_id}Delete an email template POST/v1/email-marketing/templates/{template_id}/send-testSend a test of an email template (a real email through Amazon SES)

Suppressions

GET/v1/email-marketing/suppressionsList the suppression list POST/v1/email-marketing/suppressionsAdd an address to the suppression list DELETE/v1/email-marketing/suppressions/{email}Remove an address from the suppression list

Usage

GET/v1/email-marketing/usageGet this month's email plan usage

Reports

GET/v1/email-marketing/reportsGet email marketing performance for a date range