Magidoc

launchCampaignRecipientPlay
Mutation

Launches one reviewed Campaign play. For generate_email, this queues sending the saved email draft through the campaign's assigned sender. A launched status means queued, not delivered; read getCampaignRecipients plays and delivery to verify the result. Repeated launches of an already launched or delivered play are rejected. An email with a future executionPlan.scheduledSendAt keeps it; otherwise it takes its sender's next slot in the campaign, 18 seconds after the last (200 an hour), unless sendNow is true. 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. Access: an email play only by its assigned sender, who needs a connected mailbox; other plays by the Campaign owner or a Campaign workspace admin. Errors: missing content, invalid target membership, or unauthorized launch is rejected, as is a play changed since expectedModifiedAt.

Arguments

#

playId

ID !
Non-null

expectedModifiedAt

The play's modifiedAt when its content was shown for approval; a later edit rejects the launch.

sendNow

True sends the email at once, skipping its sender's paced queue and any scheduled time.

Response

#

Returns CampaignRecipientPlay !.

Example

#