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

Campaigns & Newsletters

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

31 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.
• createGoogleAdGroup writeconsentexternal Create a PAUSED ad group inside one Video or Demand Gen campaign on the member's Google Ads account; a Video campaign's ad group holds responsive video ads.
• createGoogleCampaign writeconsentexternal Create a PAUSED Google Ads campaign, Video or Demand Gen, with its own daily budget, on one of the member's Google Ads accounts.
• createGoogleVideoAd writeconsentexternal Turn one of the member's Cloud video Files into a PAUSED Google Ads video ad.
• 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).
• listGoogleAdAccounts readexternal List the Google Ads accounts the signed-in member's own Google Ads connection can reach: each account's ten-digit customer id, name, currency, time zone, whether it is a manager, whether it is a…
• 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.
• pauseGoogleAd writeconsentexternal Pause ONE Google Ads ad on the member's account by its ad group ad resource name (customers/<customerId>/adGroupAds/<adGroupId>~<adId>).
• readGoogleAdInsights readexternal Read per-ad Google Ads performance for one account over a date range: impressions, clicks, CTR, average CPC, cost and conversions for every ad, with its campaign and ad group, costs in the account's…
• removeCampaignPackageItem write Remove a deliverable from a campaign's package.
• restoreCampaign write Restore a Campaign from Trash, exactly as it was when it was trashed (same status, audience, message and drafts).
• 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…
• setGoogleBudget writeconsentexternal Set the daily budget of ONE Google Ads campaign on the member's account; the campaign's own budget is read from Google and only its amount changes.
• 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.
• trashCampaign writedestructive Move a Campaign to Trash (the "delete a campaign" verb).
• updateCampaign write Edit a Campaign in place instead of recreating it: rename it, rewrite its message (subject, body, rich bodyHtml and images, or the ora_drafted brief), or choose which connected mail account it sends…