Magidoc

executeCampaign
Mutation

Starts execution for approved campaign recipient plans, including queued email sends. Before sending email, obtain explicit user consent for the sender, recipients and reviewed content. If consent is missing or there is any doubt about approval or scope, ask the user for explicit approval and wait for their answer before calling this tool. Approval to create or draft a campaign is not consent to send. Use recipientIds to scope a cohort; omitted recipientIds selects eligible planned recipients. An empty list is rejected. Returns before delivery: use getCampaignRecipients to read persisted play status and delivery evidence. Access: workspace members with CRM and Buzz access; email plans must be assigned to the caller. Errors: inactive campaign, unauthorized access, missing plans, or no eligible recipients.

Arguments

#

campaignId

ID !
Non-null

workspaceId

ID !
Non-null

recipientIds

[ID !]

When set, scopes execution to these planned recipients (add-people cohort).

Response

#

Returns Campaign !.

Example

#