Magidoc

prepareCampaignRecipientPlans
Mutation

Starts asynchronous drafting for selected campaign recipients and returns immediately. Recipient status progresses from queued to drafting, then to a persisted plan or failed; this does not send campaign email. Poll getCampaignRecipients until no selected recipient is queued or drafting. Finished drafts are reviewed and sent from the campaign Queue.

Arguments

#

campaignId

ID !
Non-null

plannedSendDay

String

Intended Eastern send day, YYYY-MM-DD. This does not schedule or launch email.

recipientIds

[ID !]

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

playIds

[ID !]

When set with recipientIds, drafts only these recipient plays.

Response

#

Returns [CampaignRecipientExecutionPlanProposal !]!.

Example

#