1. Docs
2. /
3. Tool reference
4. /
5. Campaigns & Newsletters

Campaigns & Newsletters

Audience campaigns, deliverable packages, send readiness, newsletters, and CAN-SPAM compliance settings.

21 verbs in this family.

• addAudienceToCampaign write Add an audience to a Campaign, or grow it.
• addCampaignPackageItem write Attach a deliverable to a campaign's package: the bundle it delivers (a Cloud page, a Studio app/website, a file, or an external link).
• createCampaign write Create a Campaign: the organizing layer over the reviewed outreach queue.
• createNewsletter write Start a newsletter: a named publication bound to a subscriber contact folder (its audience).
• createSavedView write Create a named, reusable saved view over the caller's personal contacts: a LIVE lens (a filter), not a copy of people.
• finalizeCampaign write Finalize a campaign: LOCK its send shape (audience size + channel + package version) so it is ready for the human to send.
• fireNewsletterSequence writedestructiveexternal Fire one triggered lifecycle sequence to YOUR OWN account email: a safe preview/self-test of the transactional pipeline (welcome, payment_success, payment_failed, access_approval).
• getCampaignPrep read Read a campaign's prep dashboard: audience size, package (deliverable) count, staged drafts, whether the content is ready, and whether it is finalized (and if a finalized shape has drifted).
• getCampaignSendReadiness read Answer "can I start sending this campaign, and if not what's blocking?": the send-readiness preflight.
• getComplianceSettings read Read the outreach compliance settings for the signed-in user: the CAN-SPAM physical mailing address and sender name that every campaign email must carry.
• listCampaignPackage read List a campaign's package: every deliverable it sends, each resolved to its live title and canonical URL.
• listCampaigns read List the caller's campaigns with their live status and counts (pending / sent / replied).
• listNewsletterIssues read List a newsletter's issues: the campaigns bound to its subscriber folder: newest first, each with its status (draft / active / paused / done).
• listNewsletters read List the caller's newsletters, each with its live subscriber count (from the bound folder).
• listNewsletterSequences read List the Newsletter tool's triggered/transactional sequences: the lifecycle emails that fire on an event (welcome, payment success, the graceful payment-failed, access approval), with each one's…
• listSavedViews read List the caller's own saved views: the named, reusable lenses over their contacts: each with its savedViewId, name, entity type, and filters.
• pauseCampaign write Pause an active Campaign: its queued drafts hold and none advance until you resume it.
• removeCampaignPackageItem write Remove a deliverable from a campaign's package.
• setComplianceSettings write Set the outreach compliance settings for the signed-in user: the physical mailing address (a real postal address, legally required in every commercial campaign email) and the sender name shown in…
• simulateCampaign read Simulate a campaign: a per-recipient DRY RUN showing exactly who would receive what (subject + body preview) and the resolved package links, with ZERO sends.
• startCampaign writeexternal Start a draft Campaign: fan its audience into the reviewed approve-each queue as one personalized draft per contact.