Flows

List email flows

email_marketing.flows.list

Lists the organization's email flows (automated sequences of emails, delays, conditions, label actions and internal notifications), most recently updated first, paginated by cursor. Filter by status (draft, active, paused, archived) or trigger (manual, audience_sync, event). Filters apply to the page read, so a page can bring fewer than limit while has_more is true: follow next_cursor until has_more is false. Steps are not included: use email_marketing.flows.get. Requires view access to Email Marketing.

Scope

email_marketing:read

Permission

View the module

MCP tool

email_marketing_flows_listOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.list".

Declared cost: up to 202 reads and 0 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl "https://api.mb-suite.com/v1/email-marketing/flows" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/email-marketing/flows" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Get one email flow with its steps

email_marketing.flows.get

Returns a flow (trigger, status, re-entry policy, send window, exit conditions, linked audiences, step and enrollment counters) with all its steps in reading order, as the canvas shows them: the main branch by order and, right after each condition step, its yes branch and then its no branch (each by order, nested). Condition steps branch into cond_<stepId>_yes / cond_<stepId>_no (their yes_branch_id and no_branch_id; each step says its branch_id). Use it before editing steps or enrolling contacts. Not found (email_flow_not_found) if the id is not a flow of this organization. Requires view access to Email Marketing.

Scope

email_marketing:read

Permission

View the module

MCP tool

email_marketing_flows_getOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.get".

Declared cost: up to 201 reads and 0 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Create an email flow

email_marketing.flows.create

Creates a flow in draft with a name and a trigger: manual (contacts are enrolled by hand or by API), audience_sync (members of linked audiences are enrolled automatically) or event (contact_added or contact_labeled; trigger_event_name is required). Optionally seeds email and delay steps in order: an email step can name its template by template_id or by template_name (matched case-insensitively against the organization's templates, like the screen's flow templates). Nothing is sent: activate it later with email_marketing.flows.activate. Returns flow_id. Errors: trigger_event_required, email_template_not_found. Requires full access to Email Marketing.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_createOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.create".

Declared cost: up to 1051 reads and 51 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "trigger": "manual"
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "trigger": "manual"
}'

Update an email flow's settings

email_marketing.flows.update

Updates one or more settings of a flow: name, description, trigger, trigger_config (for contact_labeled: { label_id, label_name }), trigger_event_name, send window (send_window_start/sendWindowEnd hours 0-24 and send_timezone), re-entry policy (once, multiple, cooldown with cooldown_days) and exit conditions (label_added with a contact label, or max_days). null clears a nullable field. Steps are edited with the email_marketing.flows.steps operations and the status with activate/pause/archive. Returns the updated flow. Requires full access to Email Marketing.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_updateOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.update".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X PATCH "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X PATCH "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

Duplicate an email flow

email_marketing.flows.duplicate

Copies a flow's settings and all its steps into a new draft flow named '<name> (copia)', without enrollments or linked audiences. The copy works like the original: the steps of each condition branch hang from the copied condition, and an 'opened the previous email' condition points to the copied email step. Returns the new flow_id. Requires full access to Email Marketing.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_duplicateOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.duplicate".

Declared cost: up to 201 reads and 201 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/duplicate" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/duplicate" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Activate an email flow

email_marketing.flows.activate

Turns a flow on: from then on its enrolled contacts receive its emails (the flow cron sends within minutes, inside the send window). Checks first that the organization has a verified sending domain and a mailing address (CAN-SPAM), that the flow has at least one email step and that every email step has a template, condition, label and notification steps are configured; «opened the previous email» conditions are pointed to the closest prior email of their branch. Idempotent: an active flow stays as is (changed false). Outside the app it always runs in two steps, because from then on it sends real emails: dry_run=true runs the same checks and says how many enrollments in progress start receiving, how people enter from then on (its trigger and linked audiences) and what is left of the monthly plan, with a confirm_token (10 minutes); then call it again with the confirm_token. Errors: email_domain_not_verified, email_footer_address_missing, email_sending_paused (MB Suite paused the account's email sending, details.kind bounce_rate or manual: while paused no flow sends and none can be activated), flow_without_email_step, flow_step_without_template, flow_steps_invalid (details.problems). Requires full access to Email Marketing.

Needs confirmation: first dry_run: true (preview and confirm_token, valid 10 minutes and for one run), then the same body with confirm_token. In a few operations only with certain data: the description says when. Why and how: Dry run and confirm_token.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_activateOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.activate".

Declared cost: up to 202 reads and 201 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/activate" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/activate" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Pause an email flow

email_marketing.flows.pause

Pauses an active flow: nothing is sent while it is paused and its enrollments wait where they are (they resume when the flow is activated again). Pausing an archived flow brings it back paused, without sending. Idempotent: a paused flow stays as is, and a draft (never active) stays a draft (changed false, status draft). Requires full access to Email Marketing.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_pauseOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.pause".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/pause" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/pause" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Archive an email flow

email_marketing.flows.archive

Archives a flow: it stops sending, it drops its linked audiences (no more automatic enrollment) and it no longer accepts enrollments; it keeps its steps and history. Activate it again to bring it back (audiences must be linked again). Idempotent. Use email_marketing.flows.delete to remove it. Requires full access to Email Marketing.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_archiveOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.archive".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/archive" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/archive" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Delete an email flow

email_marketing.flows.delete

Deletes a flow and all its enrollments (contacts in the middle of it stop receiving emails). The flow goes to the 30-day trash with its steps: restoring it brings it back paused if it was active, without its enrollments. Owners and admins only. Outside the screen it requires a dry run (which counts the enrollments) and a confirm_token, or a REST DELETE.

With an API key, this DELETE runs directly: the record stays 30 days in the trash and the response carries its trash_item_id. With an OAuth token, and through the MCP, it needs dry_run → confirm_token.

Scope

email_marketing:write and “Allow deletions” (email_marketing:delete in OAuth)

Permission

Edit in the module · Only owner, admin

MCP tool

email_marketing_flows_deleteOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.delete".

Declared cost: up to 5002 reads and 5001 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X DELETE "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X DELETE "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Add a step to an email flow

email_marketing.flows.steps.add

Adds a step to a flow: email (template_id of an organization template, optional subject), delay (delay_minutes), condition (condition_config: has_label with label_id, in_audience with audience_id, or opened_previous; it creates two branches, cond_<step_id>_yes and cond_<step_id>_no, where later steps go with branch_id), label_action (add or remove a contact label) or notification (an internal email to a member: recipient_user_id must be a member of this account, otherwise it is skipped). Appended at the end of its branch (default main) or right after insert_after_step_id. A flow holds up to 200 steps. Returns step_id. Requires full access to Email Marketing.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_steps_addOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.steps.add".

Declared cost: up to 203 reads and 202 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/steps" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "type": "email"
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/steps" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "type": "email"
}'

Update a step of an email flow

email_marketing.flows.steps.update

Updates a step's template, subject, delay, condition, label action or notification (the fields of its type). It does not change the step type or its place: delete and add it again, or use email_marketing.flows.steps.reorder. Returns the updated step. Not found (email_flow_step_not_found) if the step is not in that flow. Requires full access to Email Marketing.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_steps_updateOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.steps.update".

Declared cost: up to 3 reads and 2 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X PATCH "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/steps/{step_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X PATCH "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/steps/{step_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

Delete a step of an email flow

email_marketing.flows.steps.delete

Deletes a step and renumbers its branch; deleting a condition also deletes every step of its two branches (and of the branches of a condition nested inside them). Enrollments sitting on a deleted step continue from the next one. Steps are not kept in the trash: add the step again if it was a mistake. Outside the screen it requires a dry run (it names the step and counts the branch steps that go with it) and a confirm_token. Returns deleted (the steps removed). Requires full access to Email Marketing.

Needs confirmation: first dry_run: true (preview and confirm_token, valid 10 minutes and for one run), then the same body with confirm_token. In a few operations only with certain data: the description says when. Why and how: Dry run and confirm_token.

Scope

email_marketing:write and “Allow deletions” (email_marketing:delete in OAuth)

Permission

Edit in the module

MCP tool

email_marketing_flows_steps_deleteOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.steps.delete".

Declared cost: up to 202 reads and 202 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X DELETE "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/steps/{step_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X DELETE "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/steps/{step_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Reorder the steps of an email flow

email_marketing.flows.steps.reorder

Sets the order of a branch's steps: ordered_ids lists them in the new order (order 0, 1, 2…). Every id must be a step of the flow; steps not listed keep their order. Idempotent. Requires full access to Email Marketing.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_steps_reorderOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.steps.reorder".

Declared cost: up to 201 reads and 201 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/steps/reorder" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "ordered_ids": [
    "ORDERED_ID"
  ]
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/steps/reorder" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "ordered_ids": [
    "ORDERED_ID"
  ]
}'

List the enrollments of an email flow

email_marketing.flows.enrollments.list

Lists the contacts enrolled in a flow, newest first, paginated by cursor: email, name, status (active, paused, completed, cancelled, failed, exited), current step, next send time, how they entered (enrollment_source) and why they left (exit_reason, cancel_reason). Filter by status; the filter applies to the page read, so follow next_cursor until has_more is false. Requires view access to Email Marketing.

Scope

email_marketing:read

Permission

View the module

MCP tool

email_marketing_flows_enrollments_listOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.enrollments.list".

Declared cost: up to 203 reads and 0 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/enrollments" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/enrollments" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Enroll one contact in an email flow

email_marketing.flows.enrollments.enroll

Enrolls one email address (optionally with name and the contact_id of Contacts) in a flow: it starts at the first step of the main branch and, if the flow is active, its first email goes out within minutes (inside the send window) — unless MB Suite paused the account's email sending: then it waits until sending is resumed (the dry run says so). To enroll many, use email_marketing.flows.enrollments.enroll_audience. Outside the app it always runs in two steps, because in an active flow it starts real emails: dry_run=true runs the same checks (same errors) and says whether the flow is active (emails start within minutes) or the enrollment waits until it is activated, with a confirm_token (10 minutes); then call it again with the confirm_token. Errors: email_invalid, email_flow_archived, email_suppressed (unsubscribed, bounced or complained), already_enrolled (an active enrollment in this flow). Returns enrollment_id. Requires full access to Email Marketing.

Needs confirmation: first dry_run: true (preview and confirm_token, valid 10 minutes and for one run), then the same body with confirm_token. In a few operations only with certain data: the description says when. Why and how: Dry run and confirm_token.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_enrollments_enrollOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.enrollments.enroll".

Events it can emit

email_marketing.flow.enrolled

Declared cost: up to 204 reads and 2 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/enrollments" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "ana@example.com",
  "dry_run": true
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/enrollments" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "ana@example.com",
  "dry_run": true
}'

Enroll an audience's current members in an email flow

email_marketing.flows.enrollments.enroll_audience

Enrolls once every current member of an audience (a snapshot: people who join the audience later are not enrolled; for that, link it with email_marketing.flows.audiences.link). Skips invalid and repeated addresses, people already active in the flow and the suppression list. If the flow is active they start receiving its emails within minutes, counting against the email plan, and a sent email cannot be recalled; while MB Suite has the account's email sending paused they wait instead (the dry run says so). Irreversible: outside the app it always runs in two steps — dry_run=true returns the preview (how many enter, how many are left out and why, what is left of the monthly plan, the first recipients) and a confirm_token (10 minutes), then call it again with the same input and the confirm_token; the credential must allow irreversible operations (403 delete_not_allowed otherwise). Not idempotent: running it again enrolls those whose previous enrollment already ended. Returns enrolled and skipped. Errors: email_audience_not_found, email_flow_archived, audience_empty. Requires full access to Email Marketing.

Needs confirmation: first dry_run: true (preview and confirm_token, valid 10 minutes and for one run), then the same body with confirm_token. In a few operations only with certain data: the description says when. Why and how: Dry run and confirm_token.

Scope

email_marketing:write and “Allow deletions” (email_marketing:delete in OAuth)

Permission

Edit in the module

MCP tool

email_marketing_flows_enrollments_enroll_audienceOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.enrollments.enroll_audience".

Events it can emit

email_marketing.flow.enrolled

Declared cost: up to 10000 reads and 10000 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/enrollments/from-audience" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "audience_id": "AUDIENCE_ID",
  "dry_run": true
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/enrollments/from-audience" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "audience_id": "AUDIENCE_ID",
  "dry_run": true
}'

Take a contact out of an email flow

email_marketing.flows.enrollments.exit

Stops an active or paused enrollment: the contact receives nothing else from that flow (status cancelled, reason manual). Idempotent: an enrollment that already ended stays as is (changed false). It does not unsubscribe the address from other flows or campaigns: for that add it with email_marketing.suppressions.add. Requires full access to Email Marketing.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_enrollments_exitOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.enrollments.exit".

Events it can emit

email_marketing.flow.exited

Declared cost: up to 2 reads and 2 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flow-enrollments/{enrollment_id}/exit" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flow-enrollments/{enrollment_id}/exit" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Link an audience to an email flow

email_marketing.flows.audiences.link

Links an audience to a flow (meant for the audience_sync trigger): its current members are enrolled now and, while the flow is active, people who join the audience later are enrolled automatically about every 15 minutes (each address once per flow). Skips invalid, repeated and suppressed addresses and people already active. If the flow is active the emails start within minutes and a sent email cannot be recalled; while MB Suite has the account's email sending paused nobody is enrolled automatically and the enrolled wait (the dry run says so). Irreversible: outside the app it always runs in two steps — dry_run=true returns the preview (how many enter now, how many are left out and why, what is left of the monthly plan) and a confirm_token (10 minutes), then call it again with the same input and the confirm_token; the credential must allow irreversible operations (403 delete_not_allowed otherwise). Returns enrolled and skipped. Errors: email_audience_not_found, email_flow_archived, audience_already_linked. Requires full access to Email Marketing.

Needs confirmation: first dry_run: true (preview and confirm_token, valid 10 minutes and for one run), then the same body with confirm_token. In a few operations only with certain data: the description says when. Why and how: Dry run and confirm_token.

Scope

email_marketing:write and “Allow deletions” (email_marketing:delete in OAuth)

Permission

Edit in the module

MCP tool

email_marketing_flows_audiences_linkOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.audiences.link".

Events it can emit

email_marketing.flow.enrolled

Declared cost: up to 10002 reads and 10001 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/audiences" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "audience_id": "AUDIENCE_ID",
  "dry_run": true
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/audiences" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "audience_id": "AUDIENCE_ID",
  "dry_run": true
}'

Unlink an audience from an email flow

email_marketing.flows.audiences.unlink

Stops enrolling an audience's new members in a flow. Contacts already enrolled stay in the flow (take them out one by one with email_marketing.flows.enrollments.exit). Idempotent (changed false if it was not linked). Requires full access to Email Marketing.

Scope

email_marketing:write

Permission

Edit in the module

MCP tool

email_marketing_flows_audiences_unlinkOn the full surface; on the compact one, mb_execute_operation with id: "email_marketing.flows.audiences.unlink".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/audiences/{audience_id}/unlink" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/flows/{flow_id}/audiences/{audience_id}/unlink" \
  -H "Authorization: Bearer $MB_TEST_KEY"