MCP

Tool Reference

Reference for 154 of the 317 tools available to your AI assistant through MCP, organized by category. Every tool is listed by name under Toolsets, and your MCP client's tool list shows the live parameters for each one.

Choose tools by task

Start with the smallest tool set that answers your request. A connected server is not permission to change an account. Your agent can keep its own instructions and orchestration; the Synter plugin is optional.

Verify the workspace and account: Use get_connection_status, then verify_platform_accounts for the platform you need. Confirm the intended account ID; do not assume the default account is correct. Use get_credit_balance to check usage balance.
Inspect campaigns or performance: Use list_campaigns with the verified account to inspect campaigns. For performance, use the platform's performance tool with its supported date-window arguments. Keep a reporting request read-only. Platform conversion value is not necessarily received revenue.
Find a supported operation: Use list_available_scripts to discover the action, then inspect_script for its required arguments. Follow the returned schema and permissions; do not invent an action or infer write support from the platform list.
Make an authorized change and verify it: Confirm the account, target, exact change, and expected costs before using the specific write tool or execute. Execution can change live state. Inspect the result and read the resource back; use get_ad_readback where supported. A returned ID alone does not prove delivery or performance.

For evaluation, compare the required operations, permission boundaries, and total costs against your own requirements. See the current pricing and trust documentation. Request evidence for any control your review requires; connecting this server is not an endorsement or an independent certification.

How tools work

You don't need to call tools directly. Just describe what you want in natural language and your AI assistant will pick the right tool. Some tools are free and others incur usage charges — check the specific tool's cost with forecast_tool_cost and your balance with get_credit_balance.

Catalog scope

This reference describes the hosted server at https://mcp.synterai.com. It is generated from the current hosted tool manifest, including input schemas and read/write annotations. The versioned @synterai/mcp-server local compatibility package exposes a smaller tool set; pin its npm version and use that release's README when local stdio transport is required.

Beyond these tools: execute()

The tools above cover the common cases, but execute in the Advanced category is a general-purpose escape hatch into a much larger internal script library (several hundred platform-specific actions) — use list_available_scripts to browse it and inspect_script to see an action's exact arguments before calling it.

Getting Started

Start the legacy authenticated email onboarding handoff

Parameters

emailstring

Your work email address

Poll until email verification completes, then open the secure OAuth install guide

Parameters

session_tokenstring

The session token returned by synter_onboarding_start

device_codestring

The device_code returned by synter_onboarding_start

Account & Connections

See ALL connected accounts: ad platforms, analytics (GA4, PostHog), CRM (HubSpot, Attio), and more (free)

Parameters

limitnumber

Max items per page (default: 50, max: 500)

offsetnumber

Optional zero-based offset; takes precedence over page.

pagenumber

Page number (1-indexed, default: 1)

platformstring

Optional exact, case-insensitive platform filter (e.g. 'GOOGLE'). Unknown values return no accounts; omitted or empty means all platforms.

Verify which ad account each platform's pull tools would use by default, with recent activity per connected account. Flags when the default account is dormant while a sibling account has spend (free). Call this before pull_*_performance when a platform has multiple accounts or returns suspicious zeros.

Parameters

platformstring

Optional platform filter (e.g. "X", "REDDIT", "GOOGLE"). Omit to verify all connected ad platforms.

daysnumber

Activity window in days (default: 7).

List the workspaces you belong to and show which one this connection is working in (free). Use it when results look like the wrong workspace, or before update_active_workspace.

No parameters required.

Switch which workspace this connection works in, by id or exact name from get_workspaces (free). Persists for later calls and new chats on this connection; your other connections and API keys are unchanged. Only workspaces you are an active member of are allowed.

Parameters

workspacestringrequired

Workspace id (e.g. "1201") or exact workspace name

Check ALL platform connections: ad platforms, analytics (GA4, PostHog), CRM (HubSpot, Attio), and more (free)

Parameters

demoboolean

Optional boolean to return realistic sandbox demonstration data without connecting an account.

Read Synter billing for this workspace. view: status (subscription access and usage balance), balance (credit balance and pricing), vendor_consumption (paid data consumed over since_days), tool_cost (charge for tool_name before calling it). Covers get_billing_status, get_credit_balance, get_vendor_consumption and forecast_tool_cost. No credits charged.

Parameters

viewstring

Default status.

statusbalancevendor_consumptiontool_cost

tool_namestring

Tool to price (view tool_cost only).

since_daysnumber

Window in days, 1-365, default 30 (view vendor_consumption only).

Superseded by get_billing (still callable, not listed). Check your credit balance and pricing (free)

No parameters required.

Check the status of an async job (e.g. audience sync). Returns job status, result on success, or error on failure. No credits charged.

Parameters

job_idstringrequired

The job ID returned by the async tool (UUID format)

Performance Reporting

Get Google Ads campaign metrics — impressions, clicks, spend, conversions per campaign (2 credits). Date window: date_range preset (today, yesterday, last_7_days, last_14_days, last_30_days, last_90_days), start_date/end_date (YYYY-MM-DD) for custom ranges like weekends, or days for a rolling window. When more than one Google Ads account is connected, pass account_name (or account_id) to choose which account to read.

Parameters

daysnumber

Number of days to look back (default: 30). Ignored when date_range or start_date/end_date are provided.

date_rangestring

Optional preset window. Explicit start_date/end_date take precedence.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_days

levelstring

Data granularity (default: campaigns)

campaignsad-groupskeywordsadssearch-terms

account_idstring

Optional specific Google Ads customer ID. If not provided, uses the user's primary connected account.

account_namestring

Optional account name for disambiguation when multiple accounts are connected. Pass the name the user mentions (e.g., "leafypod") — the system will match it.

start_datestring

Optional fixed window start (YYYY-MM-DD). Requires end_date.

end_datestring

Optional fixed window end (YYYY-MM-DD). Requires start_date.

demoboolean

Optional boolean to return realistic sandbox demonstration data without connecting an account.

include_ad_textboolean

level=ads only. Include headlines/descriptions/final_urls. Defaults to true, or false when segment is set (text repeats per row).

limitnumber

Optional max rows per page (1..5000).

offsetnumber

Rows to skip (pagination). Pass the previous page's next_offset.

segmentstring

Optional time breakdown: "date" (one row per entity per day) or "week" (per ISO week, Monday start). Each row carries the segment value under the same key.

dateweek

Get Meta (Facebook/Instagram) Ads metrics — impressions, clicks, spend, conversions per campaign (2 credits). Date window: date_range preset (today, yesterday, last_7_days, last_14_days, last_30_days, last_90_days), start_date/end_date (YYYY-MM-DD) for custom ranges, or days for a rolling window. When more than one Meta Ads account is connected, pass account_name (or account_id) to choose which account to read.

Parameters

daysnumber

Number of days to look back (default: 30). Ignored when date_range or start_date/end_date are provided.

date_rangestring

Optional preset window. Explicit start_date/end_date take precedence.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_days

levelstring

Data granularity (default: campaign)

campaignad-setadcreativeplacement

account_idstring

Optional specific Meta ad account ID

account_namestring

Optional account name for disambiguation when multiple accounts are connected.

start_datestring

Optional fixed window start (YYYY-MM-DD). Requires end_date.

end_datestring

Optional fixed window end (YYYY-MM-DD). Requires start_date.

demoboolean

Optional boolean to return realistic sandbox demonstration data without connecting an account.

campaign_idstring

Optional: only return rows for this Meta campaign ID.

breakdownstring

total (default) = one row per entity over the window; daily = per-day rows.

totaldaily

limitnumber

Rows per page (default 50, max 5000; 0 requests the maximum). Response includes next_offset when more rows exist.

offsetnumber

Row offset for paging (default 0).

sort_bystring

Optional sort field; ad-level results default to launch_date.

sort_orderstring

Sort direction (default desc).

ascdesc

dailyboolean

Return per-day rows. breakdown=daily also enables this behavior.

custom_conversion_idstring | number

Optional Meta custom conversion ID.

custom_event_namestring

Optional custom event name to report.

name_prefixstring

Optional name prefix filter (e.g. 'B9_') for batch view.

launch_daysnumber

Optional filter for ads launched within the last N days.

launch_date_afterstring

Optional filter for ads launched on or after YYYY-MM-DD.

placement_breakdownboolean

Optional boolean to attach per-placement breakdowns to each ad row.

roll_upboolean

Optional boolean to roll up ads sharing the same creative across campaigns.

include_long_fieldsboolean

Optional boolean to include primary_text, trend/benchmark detail and other long fields in ad rows (omitted by default so more rows fit per size-capped page).

rollup_creativeboolean

Optional boolean to aggregate metrics across ads by creative ID.

Proof Pack: read a launched ad's creative + CTA back from the platform API (the source of truth) and verify the CTA against the platform enum and the copy against ad policy (2 credits). Meta, Reddit, LinkedIn, and Google Ads supported today; other platforms return a clearly-labeled unsupported result. Google also accepts ad_group_id, campaign_id, or the raw create_result.

Parameters

platformstringrequired

Platform the ad was launched on (e.g. "meta").

ad_idstring

The platform ad ID returned by upload_creative / create_*_ad. Optional for Google when ad_group_id, campaign_id or create_result is given.

ad_idsstring

Comma-separated Meta ad IDs for batch creative readback.

account_idstring

Optional specific ad-account ID holding the ad (Google: customer ID).

approved_ctastring

Optional brief-approved CTA to verify the launched CTA against.

ad_group_idstring

Google only: read back the ads in this ad group.

campaign_idstring

Google only: read back the ads in this campaign.

create_resultstring

Google only: the JSON result of the create call; ad / ad group / campaign IDs are extracted from it.

Get LinkedIn Ads metrics — impressions, clicks, spend, conversions per campaign (2 credits). Date window: date_range preset (today, yesterday, last_7_days, last_14_days, last_30_days, last_90_days), start_date/end_date (YYYY-MM-DD) for custom ranges, or days for a rolling window. Pass campaign_group_ids (comma-separated) to filter to specific campaign groups. When more than one LinkedIn account is connected, pass account_name (or account_id) to choose which account to read.

Parameters

daysnumber

Number of days to look back (default: 30). Ignored when date_range or start_date/end_date are provided.

date_rangestring

Optional preset window.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_days

levelstring

Data granularity (default: campaign). Accepts 'campaign' or 'creative'.

campaigncreative

account_idstring

Optional specific LinkedIn ad account ID

account_namestring

Optional account name for disambiguation when multiple accounts are connected.

start_datestring

Optional fixed window start (YYYY-MM-DD). Requires end_date.

end_datestring

Optional fixed window end (YYYY-MM-DD). Requires start_date.

campaign_group_idsstring

Optional comma-separated LinkedIn Campaign Group IDs to filter by; only campaigns within these groups are returned.

Get X (Twitter) Ads metrics — impressions, clicks, spend, conversions per campaign (2 credits). Date window: date_range preset (today, yesterday, last_7_days, last_14_days, last_30_days, last_90_days), start_date/end_date (YYYY-MM-DD) for custom ranges, or days for a rolling window. When more than one X Ads account is connected, pass account_name (or account_id) to choose which account to read.

Parameters

daysnumber

Number of days to look back (default: 30). Ignored when date_range or start_date/end_date are provided.

date_rangestring

Optional preset window.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_days

account_idstring

Optional specific X Ads account ID

account_namestring

Optional account name for disambiguation when multiple accounts are connected.

start_datestring

Optional fixed window start (YYYY-MM-DD). Requires end_date.

end_datestring

Optional fixed window end (YYYY-MM-DD). Requires start_date.

campaign_idstring

Optional specific campaign ID to filter by.

campaign_idsstring

Optional comma-separated list of campaign IDs to filter by.

Get Reddit Ads metrics — impressions, clicks, spend, conversions per campaign (2 credits). Date window: date_range preset (today, yesterday, last_7_days, last_14_days, last_30_days, last_90_days), start_date/end_date (YYYY-MM-DD) for custom ranges, or days for a rolling window. When more than one Reddit Ads account is connected, pass account_name (or account_id) to choose which account to read.

Parameters

daysnumber

Number of days to look back (default: 30). Ignored when date_range or start_date/end_date are provided.

date_rangestring

Optional preset window.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_days

account_idstring

Optional specific Reddit ad account ID

account_namestring

Optional account name for disambiguation when multiple accounts are connected.

start_datestring

Optional fixed window start (YYYY-MM-DD). Requires end_date.

end_datestring

Optional fixed window end (YYYY-MM-DD). Requires start_date.

Get Microsoft (Bing) Ads metrics — impressions, clicks, spend, conversions per campaign (2 credits). Date window: date_range preset (today, yesterday, last_7_days, last_14_days, last_30_days, last_90_days), start_date/end_date (YYYY-MM-DD) for custom ranges, or days for a rolling window. When more than one Microsoft Ads account is connected, pass account_name (or account_id) to choose which account to read.

Parameters

daysnumber

Number of days to look back (default: 30). Ignored when date_range or start_date/end_date are provided.

date_rangestring

Optional preset window.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_days

account_idstring

Optional specific Microsoft Ads account ID

account_namestring

Optional account name for disambiguation when multiple accounts are connected.

start_datestring

Optional fixed window start (YYYY-MM-DD). Requires end_date.

end_datestring

Optional fixed window end (YYYY-MM-DD). Requires start_date.

breakdownstring

Optional breakdown dimension (e.g. conversion_action, device, age_range, gender, geo_country, geo_region, or all).

breakdownsstring

Alias for breakdown.

conversion_goalsboolean

Optional flag to include conversion goal breakdown.

levelstring

Reporting level: 'campaign' (default), 'ad-group', or 'ad'.

limitnumber

Optional maximum number of entity rows to return.

offsetnumber

Number of entity rows to skip (default: 0).

campaign_idstring

Optional campaign ID to filter results to one campaign.

demoboolean

Optional demo mode flag.

Get TikTok Ads metrics — impressions, clicks, spend, conversions per campaign (2 credits). Date window: date_range preset (today, yesterday, last_7_days, last_14_days, last_30_days, last_90_days), start_date/end_date (YYYY-MM-DD) for custom ranges, or days for a rolling window. For detailed video engagement metrics use tiktok_ads_get_insights. When more than one TikTok Ads account is connected, pass account_name (or account_id) to choose which account to read.

Parameters

daysnumber

Number of days to look back (default: 30). Ignored when date_range or start_date/end_date are provided.

date_rangestring

Optional preset window.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_days

account_idstring

Optional specific TikTok advertiser ID

account_namestring

Optional account name for disambiguation when multiple accounts are connected.

start_datestring

Optional fixed window start (YYYY-MM-DD). Requires end_date.

end_datestring

Optional fixed window end (YYYY-MM-DD). Requires start_date.

Pull Amazon DSP campaign performance data (2 credits)

Parameters

daysnumber

Number of days to look back (default: 30, max: 90)

account_idstring

Optional specific Amazon DSP advertiser ID

account_namestring

Optional account name for disambiguation.

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get Amazon Ads (Sponsored Products/Brands/Display) metrics (2 credits). When counting 'live' campaigns, only count campaigns with state=ENABLED AND active ad groups with budget remaining — ARCHIVED campaigns are NOT active. When more than one Amazon Ads account is connected, pass account_name (or account_id) to choose which account to read.

Parameters

daysnumber

Number of days to look back (default: 30, max: 90)

ad_typestring

Ad type filter (default: ALL)

SPSBSDALL

account_idstring

Optional specific Amazon Ads profile ID

account_namestring

Optional account name for disambiguation.

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get Pinterest Ads metrics (2 credits). When more than one Pinterest ad account is connected, pass account_name (or account_id) to choose which account to read.

Parameters

daysnumber

levelstring

account_idstring

account_namestring

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get Snapchat Ads metrics (2 credits). Use account_name to specify which account when multiple are connected.

Parameters

daysnumber

levelstring

account_idstring

account_namestring

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get Spotify Ads metrics (2 credits). Use account_name to specify which account when multiple are connected.

Parameters

daysnumber

account_idstring

account_namestring

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get OpenAI Ads metrics (2 credits). Pulls insights from the OpenAI Ads API. Optional scope: campaign_id, ad_group_id, or ad_id to scope the report. Defaults to the selected scope's natural aggregation level; unscoped defaults to ad_account.

Parameters

daysnumber

How many days back to pull (1-365). Defaults to 30.

campaign_idstring

Optional — scope insights to one campaign.

ad_group_idstring

Optional — scope insights to one ad group.

ad_idstring

Optional — scope insights to one ad.

aggregation_levelstring

Defaults to ad_account.

ad_accountcampaignad_groupad

time_granularitystring

Defaults to script default.

dailynone

limitnumber

Max rows to return (defaults to 1000).

account_idstring

Optional OpenAI Ads account ID (when multiple connected).

account_namestring

Optional friendly account name selector.

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get The Trade Desk metrics (2 credits). Date window: date_range preset (today, yesterday, last_7_days, last_14_days, last_30_days, last_90_days), start_date/end_date (YYYY-MM-DD) for custom ranges, or days for a rolling window. Use account_name to specify which account when multiple are connected.

Parameters

daysnumber

Number of days to look back (default: 30). Ignored when date_range or start_date/end_date are provided.

date_rangestring

Optional preset window.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_days

account_idstring

Optional specific Trade Desk partner ID

account_namestring

Optional account name for disambiguation when multiple accounts are connected.

start_datestring

Optional fixed window start (YYYY-MM-DD). Requires end_date.

end_datestring

Optional fixed window end (YYYY-MM-DD). Requires start_date.

Get FreeWheel Buyer Cloud (Beeswax) metrics (2 credits). Date window: date_range preset (today, yesterday, last_7_days, last_14_days, last_30_days, last_90_days), start_date/end_date (YYYY-MM-DD) for custom ranges, or days for a rolling window. Use account_name to specify which account when multiple are connected.

Parameters

daysnumber

Number of days to look back (default: 30). Ignored when date_range or start_date/end_date are provided.

date_rangestring

Optional preset window.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_days

account_idstring

Optional specific FreeWheel connection account id.

account_namestring

Optional account name for disambiguation.

start_datestring

Optional fixed window start (YYYY-MM-DD). Requires end_date.

end_datestring

Optional fixed window end (YYYY-MM-DD). Requires start_date.

Cross-platform reconciliation MVP — compares Google Ads ↔ Trade Desk totals for a date range, returns normalized per-platform metrics, discrepancies, and deterministic likely-cause explanations (3 credits). Read-only. Date range capped to 92 days.

Parameters

start_datestringrequired

YYYY-MM-DD (inclusive)

end_datestringrequired

YYYY-MM-DD (inclusive, must be <= yesterday)

google_account_idstring

Optional Google Ads customer ID

google_account_namestring

Optional Google account name for disambiguation

ttd_advertiser_idstring

Optional Trade Desk advertiser ID

ttd_account_namestring

Optional TTD account name for disambiguation

Get Display & Video 360 (DV360) metrics (2 credits). Use account_name to specify which account when multiple are connected.

Parameters

daysnumber

account_idstring

account_namestring

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get Campaign Manager 360 (CM360) metrics (2 credits). Use account_name to specify which account when multiple are connected.

Parameters

daysnumber

account_idstring

account_namestring

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get Walmart Connect Advertising metrics (2 credits). Returns impressions, clicks, spend, conversions, and ROAS per campaign.

Parameters

daysnumber

account_idstring

account_namestring

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get Instacart Ads metrics (2 credits). Returns impressions, clicks, spend, attributed orders, and attributed sales per campaign.

Parameters

daysnumber

account_idstring

account_namestring

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get Target Roundel retail media metrics (2 credits). Returns impressions, clicks, spend, conversions, and revenue per campaign.

Parameters

daysnumber

account_idstring

account_namestring

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Get Criteo Commerce Media metrics (2 credits). Returns displays, clicks, cost, conversions, and revenue per campaign.

Parameters

daysnumber

account_idstring

account_namestring

date_rangestring

Optional preset window; overrides days.

todayyesterdaylast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_180_dayslast_365_dayslast_2_yearslast_3_years

end_datestring

Optional end date (YYYY-MM-DD, default: today).

start_datestring

Optional start date (YYYY-MM-DD); overrides days.

Pull LinkedIn Ads Company Engagement report — shows which companies have seen your ads and how engaged they are (2 credits)

Parameters

account_idstring

LinkedIn Ads account ID (uses connected account if omitted)

daysnumber

Look-back window in days (default: 90)

audience_idstring

Optional dmpSegment ID — scope analytics to this audience

countrystring

ISO country code filter, e.g. "US" or "GB"

min_employeesnumber

Filter companies with at least this many employees

max_employeesnumber

Filter companies with at most this many employees

engagement_levelstring

Comma-separated tier filter: "VERY_HIGH,HIGH" or "MEDIUM,LOW"

limitnumber

Maximum companies to return (default: 200)

TikTok Ads (Detailed)

Get TikTok Ads performance report with video metrics (2 credits). Returns spend, impressions, clicks, CTR, conversions, CPA, ROAS, and TikTok-specific video engagement metrics per campaign/adgroup/ad.

Parameters

daysnumber

Number of days to look back (default: 7)

data_levelstring

Data level (default: AUCTION_CAMPAIGN)

AUCTION_CAMPAIGNAUCTION_ADGROUPAUCTION_AD

account_idstring

Optional specific TikTok advertiser ID

account_namestring

Optional account name for disambiguation.

Get full TikTok ad group configuration (free). Returns targeting, budget, bid, pixel, optimization goal, languages, locations, age groups, identity.

Parameters

adgroup_idstringrequired

The ad group ID to fetch

account_idstring

Optional specific TikTok advertiser ID

account_namestring

Optional account name for disambiguation.

List all TikTok ad groups, optionally filtered by campaign (free). Returns ID, name, status, budget, bid, optimization goal.

Parameters

campaign_idstring

Optional campaign ID to filter ad groups

account_idstring

Optional specific TikTok advertiser ID

account_namestring

Optional account name for disambiguation.

List all TikTok ads, optionally filtered by ad group (free). Returns ad_id, ad_name, adgroup_id, campaign_id, status, ad_format.

Parameters

adgroup_idstring

Optional ad group ID to filter ads

account_idstring

Optional specific TikTok advertiser ID

account_namestring

Optional account name for disambiguation.

Update a TikTok ad group: status, budget, locations, age targeting, bid, languages, audiences, optimization goal, pixel tracking (5 credits)

Parameters

adgroup_idstringrequired

The ad group ID to update

statusstring

New status

ENABLEPAUSE

budgetnumber

Daily budget in dollars

locationsstring

Space-separated location IDs (e.g. "6252001 2635167" for US, UK)

age_minnumber

Minimum age (e.g. 25). Mapped to TikTok age groups.

age_maxnumber

Maximum age (e.g. 55). Use 0 for no upper limit (55+).

bidnumber

Bid price in dollars

bid_typestring

Bid strategy

BID_TYPE_NO_BIDBID_TYPE_CUSTOM

languagesstring

Space-separated language codes (e.g. "en fr de")

audience_idsstring

Comma-separated custom audience IDs to include

excluded_audience_idsstring

Comma-separated custom audience IDs to exclude

optimization_goalstring

Optimization goal

CLICKCONVERTSHOWREACHVIDEO_VIEWENGAGED_VIEWLEAD_GENERATIONINSTALLIN_APP_EVENT

pixel_idstring

Pixel ID for conversion tracking (numeric or alphanumeric pixel_code)

conversion_eventstring

Conversion event name (e.g. CompleteRegistration, Purchase). Auto-mapped to TikTok enum.

account_idstring

Optional specific TikTok advertiser ID

account_namestring

Optional account name for disambiguation.

Get full TikTok campaign configuration by ID (free). Returns name, objective, budget, status, timestamps.

Parameters

campaign_idstringrequired

The campaign ID to fetch

account_idstring

Optional specific TikTok advertiser ID

account_namestring

Optional account name for disambiguation.

Campaign Management

List campaigns for any ad platform (2 credits)

Parameters

platformstringrequired

Ad platform

googlemetalinkedinredditmicrosofttiktokxamazon_dsp

account_idstring

Optional specific account ID for the platform

statusstring

Optional filter by status

ENABLEDPAUSEDREMOVED

account_namestring

Optional name to select which account when multiple are connected for the same platform

demoboolean

Optional boolean to return realistic sandbox demonstration data without connecting an account

Pause a campaign on any ad platform (2 credits)

Parameters

platformstringrequired

Ad platform

googlemetalinkedinredditmicrosofttiktokxamazon_dsp

campaign_idstringrequired

The campaign ID to pause

account_idstring

Optional specific account ID

account_namestring

Optional name to select which account when multiple are connected for the same platform

Create a Meta (Facebook/Instagram) ad in an existing ad set (20 credits)

Parameters

adset_idstring

Parent ad set id. A single real id — wildcards are rejected.

adset_idsstring[]

List of parent ad set ids for multi-ad-set creation.

qa_passstring|string[]

Verified creative QA pass binding for this action.

namestring

Ad name.

creative_idstring

Existing creative id to reuse.

page_idstring

Facebook Page id, required when building a new creative.

linkstring

Destination URL for a new creative.

messagestring

Primary text.

headlinestring

Headline text.

descriptionstring

Description text.

call_to_actionstring

CTA enum, e.g. LEARN_MORE, SIGN_UP, SHOP_NOW.

image_urlstring

Image URL to upload.

image_hashstring

Pre-uploaded image hash (alternative to image_url).

video_idstring

Video asset id.

video_urlstring

Video URL to upload.

instagram_user_idstring

Instagram account id for IG placements.

qa_passstring|string[]

QA pass bindings returned by qa_pass_bindings; not a bypass.

statusstring

Defaults to PAUSED — new ads should be reviewed before they spend.

ACTIVEPAUSED

account_idstring

Specific ad account id.

account_namestring

Select among several connected Meta accounts by name.

allow_weak_creative_variantsboolean

In multi-variant mode, ship even if a field you used is under-filled (e.g. 3 messages but only 1 headline). Deliberate exception only — default is to block.

descriptionsstring[]

2+ description variants (multi-variant creative).

headlinesstring[]

2+ headline variants (multi-variant creative).

messagesstring[]

2+ primary-text variants for a multi-variant (Advantage+ / dynamic) creative — Meta's asset_feed_spec combines and optimizes across whatever variants you give it per field. Per the meta-creative-patterns skill this is the platform's expert default at scale (82% of creative-known spend). Combine with `headlines`/`descriptions`; passing more than one value in ANY of the three engages multi-variant mode for all of them.

feed_image_urlstring

Feed placement image URL.

feed_image_hashstring

Pre-uploaded feed placement image hash.

feed_video_idstring

Feed placement video asset id.

feed_video_urlstring

Feed placement video URL to upload.

story_image_urlstring

Story placement image URL.

story_image_hashstring

Pre-uploaded story placement image hash.

story_video_idstring

Story placement video asset id.

story_video_urlstring

Story placement video URL to upload.

reel_image_urlstring

Reel placement image URL.

reel_image_hashstring

Pre-uploaded reel placement image hash.

reel_video_idstring

Reel placement video asset id.

reel_video_urlstring

Reel placement video URL to upload.

vertical_image_urlstring

Vertical (9:16) image URL.

vertical_image_hashstring

Pre-uploaded vertical image hash.

vertical_video_idstring

Vertical video asset id.

vertical_video_urlstring

Vertical video URL to upload.

gdrive_folder_urlstring

Google Drive folder URL for bulk asset ingestion.

placement_assets_jsonstring

JSON blob mapping placement names to asset specs.

Create a Reddit ad from an existing post in an ad group (20 credits)

Parameters

ad_group_idstringrequired

Parent ad group id. A single real id — wildcards rejected.

post_idstringrequired

The post to promote, e.g. t3_1vbvcb7.

qa_passstring|string[]

Verified creative QA pass binding for this action.

namestring

Ad name.

click_urlstring

Destination URL. Reddit rejects a click_url on free-form (TEXT) posts — only link posts carry one.

statusstring

Defaults to PAUSED.

ACTIVEPAUSED

campaign_namestring

Campaign name used for UTM auto-append.

no_utmboolean

Skip UTM auto-append.

qa_passstring|string[]

QA pass bindings returned by qa_pass_bindings; not a bypass.

account_idstring

Specific ad account id.

account_namestring

Select among several connected Reddit accounts by name.

Enable/resume a paused campaign on any ad platform (2 credits)

Parameters

platformstringrequired

Ad platform

googlemetalinkedinredditmicrosofttiktokxamazon_dsp

campaign_idstringrequired

The campaign ID to enable

account_idstring

Optional specific account ID

account_namestring

Optional name to select which account when multiple are connected for the same platform

Update a campaign's daily budget (5 credits)

Parameters

platformstringrequired

Ad platform

googlemetalinkedinredditmicrosofttiktokxamazon_dsp

campaign_idstringrequired

The campaign ID to update

daily_budgetnumberrequired

New daily budget in account currency (e.g., 50.00 for $50/day)

account_idstring

Optional specific account ID

account_namestring

Optional name to select which account when multiple are connected for the same platform

Google Tag Manager

Read Google Tag Manager. resource: containers (accounts and containers; call first), tags (tag summaries, live or workspace drafts), tag (full definition of tag_id incl. Custom HTML body and firing triggers). Covers list_gtm_containers, list_gtm_tags and get_gtm_tag. No credits charged.

Parameters

resourcestring

Default containers.

containerstagstag

account_idstring

GTM account ID (tags, tag; optional if the connection pins a container)

container_idstring

GTM container ID (tags, tag; optional if the connection pins a container)

tag_idstring

Tag ID (resource tag only, required there)

sourcestring

live (default) or workspace (resource tags only)

liveworkspace

Superseded by gtm_get_resources (still callable, not listed). List Google Tag Manager accounts and containers for the connected GTM user (free). Returns each account's id/name and its containers' id/name/publicId.

No parameters required.

Superseded by gtm_get_resources (still callable, not listed). List the tags in a GTM container (free). Returns tag summaries: tagId, name, type, paused. Pass account_id/container_id, or rely on the connection's defaults.

Parameters

account_idstring

GTM account ID (optional if the connection pins a container)

container_idstring

GTM container ID (optional if the connection pins a container)

sourcestring

live (published, default) or workspace (unpublished draft)

Superseded by gtm_get_resources (still callable, not listed). Get the full definition of one GTM tag (free), including its parameters (the html body for Custom HTML tags) and firing triggers.

Parameters

tag_idstringrequired

The tag ID to fetch (required)

account_idstring

GTM account ID (optional if the connection pins a container)

container_idstring

GTM container ID (optional if the connection pins a container)

Replace the HTML body of an existing GTM Custom HTML tag (2 credits). Modifies live site tracking once the container is published. Only type 'html' tags are allowed; the change stays in the workspace until publish_gtm_container runs.

Parameters

tag_idstringrequired

The tag ID to update (required)

htmlstringrequired

The new HTML body for the tag (required)

account_idstring

GTM account ID (optional if the connection pins a container)

container_idstring

GTM container ID (optional if the connection pins a container)

Publish a GTM container — creates a version from the default workspace and publishes it (2 credits). Pushes all workspace changes live to the site's tracking immediately. Approval-gated.

Parameters

account_idstring

GTM account ID (optional if the connection pins a container)

container_idstring

GTM container ID (optional if the connection pins a container)

version_namestring

Optional name for the published container version

conflict_resolutionstring

Optional merge conflict strategy. Use "keep_workspace" only when the user explicitly approved keeping the workspace version for GTM conflicts.

Analytics & Query

Execute a Google Ads Query Language (GAQL) query (2 credits). Use account_name to specify which account when multiple are connected.

Parameters

querystringrequired

The GAQL query to execute. Example: SELECT campaign.name, metrics.impressions FROM campaign WHERE segments.date DURING LAST_30_DAYS

account_idstring

Optional Google Ads customer ID

account_namestring

Optional account name for disambiguation when multiple accounts are connected.

limitnumber

Max rows to return per page (1..100000)

offsetnumber

Number of rows to skip for pagination (pass previous next_offset)

page_tokenstring

Optional cursor alias for offset

formatstring

Output format: json (default) or csv. csv returns up to ~500KB inline plus download_url, a private link to the full CSV that expires in 15 minutes (Synter keeps no copy of the rows).

output_csvstring

Optional server-side CSV path. The file is deleted once read; use download_url for the full export.

customer_idstring

Optional Google Ads customer ID (alias of account_id)

List your Google Analytics 4 properties (free)

Parameters

account_idstring

Optional specific GA4 account ID

Run a Google Analytics 4 report (free). Supports explicit YYYY-MM-DD start/end dates, relative date tokens (today, yesterday, NdaysAgo), date range presets/spans, and list or comma-separated metrics/dimensions. Pass property_id to query a specific GA4 property instead of the connection default.

Parameters

metricsstring | string[]

Metrics as a list or comma-separated string (e.g., ["sessions","totalUsers","conversions"] or "sessions,totalUsers,conversions")

dimensionsstring | string[]

Dimensions as a list or comma-separated string (e.g., ["date"] or "date,sessionSource")

daysnumber

Number of days to look back (default: 28 when no dates provided)

start_datestring

Start date as strict YYYY-MM-DD (e.g. '2026-10-24') or GA4 relative token ('today', 'yesterday', 'NdaysAgo'). Also accepts startDate.

end_datestring

End date as strict YYYY-MM-DD (e.g. '2026-10-30') or GA4 relative token ('today', 'yesterday', 'NdaysAgo'). Also accepts endDate.

startDatestring

CamelCase alias for start_date

endDatestring

CamelCase alias for end_date

date_rangestring | object

Date range string (e.g. '2026-10-24..2026-10-30'), preset ('last_7_days', 'last_14_days', 'last_28_days', 'last_30_days', 'last_90_days', 'today', 'yesterday'), or object with startDate/endDate

account_idstring

Optional connection account selector

property_idstring | number

Optional numeric GA4 property ID to report on (overrides the connection's pinned GA4_PROPERTY_ID). Use ga4_get_properties to find it.

List GA4 conversion events (free). Pass property_id to query a specific GA4 property instead of the connection default.

Parameters

account_idstring

Optional connection account selector

property_idstring | number

Optional numeric GA4 property ID (overrides the connection's pinned GA4_PROPERTY_ID)

Pixel & Conversion Tracking

Superseded by get_pixel_health (still callable, not listed). Cross-validate that the pixel/tag IDs on a landing page belong to the connected ad account. Detects wrong-pixel installs, domain registration gaps, and CAPI mismatches. No credits charged.

Parameters

urlstringrequired

Landing page URL to inspect.

platformstringrequired

Ad platform

METAGOOGLE_ADSREDDITTIKTOKLINKEDIN

account_idstring

Optional specific account ID; uses the user's active connection if omitted.

page_pixel_idstring

ID observed on the rendered page. Checked against provider ownership instead of re-extracting from static HTML.

Superseded by get_pixel_health (still callable, not listed). List Synter Pixel sites and their CAPI event-forwarding destinations for the active workspace. Shows platform, enabled/disabled state, and configured IDs. No credits charged.

Parameters

site_keystring

Optional pixel site key (sp_...) to scope to one site. If omitted, returns all sites for the workspace.

Synter Pixel and conversion tracking reads. view: health (default; snippet installed, destinations configured, last CAPI delivery per adapter), destinations (pixel sites and CAPI forwarding destinations), deliveries (event delivery rows), ownership (does the pixel on url belong to the connected platform account). Covers get_pixel_destinations, list_event_deliveries and verify_pixel_ownership. Do not pause or scale from get_performance alone. No credits charged.

Parameters

viewstring

Default health.

healthdestinationsdeliveriesownership

site_keystring

Optional pixel site key (sp_...) to scope to one site (health, destinations, deliveries).

statusstring

Filter by delivery status (deliveries).

PENDINGSUCCESSRETRYINGFAILED

platformstring

Destination platform (deliveries) or ad platform META, GOOGLE_ADS, REDDIT, TIKTOK, LINKEDIN (ownership, required there).

limitnumber

Max rows, default 50, max 200 (deliveries).

urlstring

Landing page URL to inspect (ownership, required there).

account_idstring

Optional account ID (ownership).

page_pixel_idstring

Pixel ID observed on the rendered page (ownership).

Superseded by get_pixel_health (still callable, not listed). Read event_deliveries fan-out rows (success/fail/destination). Confirm deliveries before pause/budget from get_performance. No credits charged.

Parameters

site_keystring

Optional pixel site key (sp_...).

statusstring

Filter by delivery status

PENDINGSUCCESSRETRYINGFAILED

platformstring

Filter by destination platform.

limitnumber

Max rows (default 50, max 200).

Return stored click IDs and UTMs from pixel ingest plus Stripe first-touch. Stored identifiers only — no first/last/linear model math. No credits charged.

Parameters

site_keystring

Optional pixel site key (sp_...).

user_idnumber

Optional user id for stored Stripe first-touch.

emailstring

Optional email to match pixel events.

limitnumber

Max rows (default 50, max 200).

Create or update a Synter Pixel CAPI event-forwarding destination. Sets the platform-specific IDs needed to fan out conversion events server-side. Supports Google (customer_id + conversion_action_id), Meta/Reddit (pixel_id), LinkedIn (conversion_rule_id), TikTok (pixel_code), and Snapchat. Use action='disable' or action='enable' to toggle without changing settings. No credits charged.

Parameters

platformstringrequired

GOOGLE, META, LINKEDIN, REDDIT, TIKTOK, SNAPCHAT, etc.

actionstring

Default: upsert

upsertenabledisable

site_keystring

sp_... site key; uses first active site for the org if omitted.

customer_idstring

Google Ads customer ID (digits only, no dashes).

conversion_action_idstring

Google Ads conversion action resource ID.

pixel_idstring

Meta / Reddit / Snapchat / OpenAI Ads pixel ID.

conversion_rule_idstring

LinkedIn conversion rule ID.

pixel_codestring

TikTok pixel code.

Docs, Sheets & Publishing

Create a Google Doc (kind doc: markdown content or raw html) or Google Sheet (kind sheet: headers plus rows, or json_data), share it by link and read it back. Covers create_google_doc and create_google_sheet; billed as export_google_docs (5 credits).

Parameters

kindstringrequired

doc or sheet.

docsheet

titlestringrequired

File title.

contentstring

Markdown content (doc).

htmlstring

Raw HTML content (doc).

headersstring

Comma-separated header row (sheet).

rowsarray

Comma-separated data rows (sheet).

json_datastring

JSON array of objects (sheet).

Read a Google Drive file. kind drive (default): a Picker-attached file by file_id, or a public Drive/Docs file or folder by url. kind sheet: rows from a connected Google Sheet by spreadsheet_id or url. Covers read_google_drive_file and read_google_sheet. No credits charged.

Parameters

kindstring

Default drive.

drivesheet

urlstring

Public Drive/Docs URL (drive) or Sheet URL (sheet).

file_idstring

Picker-attached file id (drive).

spreadsheet_idstring

Spreadsheet id (sheet).

rangestring

A1 range (sheet).

header_rownumber

1-based header row, default 1 (sheet).

max_rowsnumber

Maximum rows to return (sheet).

Superseded by create_google_file (still callable, not listed). Create a Google Doc from markdown or HTML content (5 credits)

Parameters

titlestringrequired

Document title

contentstring

Markdown content for the document. Supports headings, bold, italic, links, lists. Use this for campaign plans, reports, etc.

htmlstring

Raw HTML content (alternative to markdown). Use for rich formatting.

share_with_linkboolean

Grant anyone with the link edit access (default false: private to the connected Google account).

Publish a markdown blog post to a connected GitHub repo: commit <content_path>/<slug>.md and open a PR (which triggers the site's deploy). No credits charged.

Parameters

slugstringrequired

URL slug; also the markdown filename (<slug>.md).

titlestringrequired

Post title (rendered + used in front matter and the PR title).

markdownstringrequired

The article body in markdown (no front matter — it's generated).

descriptionstring

Meta description (defaults to the title).

datestring

Publish date YYYY-MM-DD (defaults to today).

categorystring

Content category (e.g. "guides", "comparisons", "product").

tagsstring

Comma-separated tags (e.g. "ABM,First-Party Data").

open_prboolean

Open a PR (default) or push directly to the deploy branch.

content_pathstring

Override the repo dir the markdown lives in (default from connection, e.g. "blog").

base_branchstring

Override the PR base / deploy branch (default from connection, e.g. "main").

Superseded by create_google_file (still callable, not listed). Create a Google Sheet from tabular data (5 credits)

Parameters

titlestringrequired

Spreadsheet title

headersstring

Comma-separated column headers (e.g., "Campaign,Spend,Clicks,ROAS")

rowsstring[]

List of comma-separated row data. Each string is one row. Example: ["Brand Search,$5000,2340,4.2", "Display,$3200,18900,2.8"]

json_datastring

JSON array of objects as alternative to headers+rows. Example: '[{"Campaign":"Brand","Spend":5000},{"Campaign":"Display","Spend":3200}]'

share_with_linkboolean

Grant anyone with the link edit access (default false: private to the connected Google account).

Superseded by get_google_file (still callable, not listed). Read tabular data (e.g. a media plan / campaign brief) from a connected Google Sheet (free)

Parameters

spreadsheet_idstring

Spreadsheet ID (or pass `url` instead)

urlstring

Full Google Sheets URL (alternative to spreadsheet_id)

rangestring

A1 range to read, e.g. "Media Plan!A1:H50". Defaults to the first tab.

header_rownumber

1-based row within the range holding column headers (default 1)

max_rowsnumber

Maximum number of data rows to return

Write values (e.g. campaign IDs / status / spend) back into a range of an existing Google Sheet (2 credits)

Parameters

rangestringrequired

A1 range to write, e.g. "Media Plan!I2:K5"

valuesstringrequired

JSON 2D array of cell values, e.g. '[["LAUNCHED","cmp_123","$0.00"]]'

spreadsheet_idstring

Spreadsheet ID (or pass `url` instead)

urlstring

Full Google Sheets URL (alternative to spreadsheet_id)

value_input_optionstring

Default: USER_ENTERED

USER_ENTEREDRAW

Landing Pages & Domains

Read native Synter embeds. view: list (all embeds plus the native-vs-hosted form capability matrix; default without embed_id), config (default with embed_id), code (install code), submissions, purchases (Stripe cart receipts). Covers list_embeds, get_embed, get_embed_code, list_embed_submissions and list_embed_purchases. No credits charged.

Parameters

embed_idstring

Embed id (required for every view except list).

viewstring

Defaults to config with embed_id, list without.

listconfigcodesubmissionspurchases

limitnumber

1-100, default 25 (submissions, purchases).

Generate an AI landing page hosted on your custom domain (600 credits)

Parameters

titlestringrequired

Page title / brand name shown in hero and browser tab

promptstringrequired

Description of the landing page (what the product/service does, target audience, key benefits). Max 5000 characters.

cta_urlstringrequired

URL the CTA button links to (e.g., signup page)

brand_urlstring

Authoritative website for the brand represented by the page. Use this for client pages in agency workspaces — cta_url/form/calendar destinations are NOT treated as brand identity. Falls back to the authenticated workspace website if omitted.

cta_textstring

CTA button text (default: "Get Started")

stylestring

Design style (default: modern)

modernminimalbold

slugstring

URL slug (auto-generated from title if omitted). Max 128 chars.

lead_formstring

Optional JSON config to embed a lead-capture form as the page's primary conversion action. Pass "{}" for the default form. An email field is always required. Submissions are stored per page and routed to connected CRMs; UTM/click-id attribution is captured automatically at serve time.

idempotency_keystring

Stable caller-generated identity for safe retries. When omitted, derived from these inputs. Reuse for the same logical generation; a deliberate new generation needs a new key. Call get_job_status to retrieve saved work after reconnecting.

Publish a landing page draft, making it live at synterai.com/lp/{slug} (free)

Parameters

slugstringrequired

The slug of the landing page to publish (returned by create_landing_page)

acknowledge_benchmarkboolean

Publish even though the page lost its last competitor benchmark. Only after the user has been told it lost and agreed.

Set landing-page conversion pixels and the Google Ads conversion label, and wire a Fillout embed so form submits count as campaign conversions and route to HubSpot. No credits charged to edit an existing page you own. Returns google_send_to plus a Fillout webhook URL.

Parameters

slugstringrequired

The landing page slug to update

google_conversion_labelstring

Google Ads conversion label (the part after AW-.../)

fillout_form_idstring

Fillout form id (the /t/{id} token)

google_pixel_idstring

Google tag id (AW-...)

meta_pixel_idstring

Meta pixel id

linkedin_pixel_idstring

LinkedIn partner id

reddit_pixel_idstring

Reddit pixel id (a2_...)

rotate_webhook_tokenboolean

Issue a new Fillout webhook token

ga4_measurement_idstring

Workspace-owned GA4 web stream measurement ID (G-...).

Update the HTML content of an existing landing page you own without AI regeneration (free edit). Use this to patch copy, add logos, or tweak layout after reviewing a draft. If the slug does not exist yet, this creates a new hosted page and is billed like create_landing_page (forecast_tool_cost has the live rate).

Parameters

slugstringrequired

The landing page slug to update

html_contentstringrequired

Full HTML string to replace the current content

Upload raw HTML as a new landing-page draft (no AI generation). Use to import an exported .html file or hand-written markup (embedded forms, Cal.com embeds, thank-you pages all supported). Then publish_landing_page and attach it to an ad campaign. Creating a new hosted page is billed like create_landing_page (forecast_tool_cost has the live rate); re-uploading to a slug you already own is a free edit.

Parameters

html_contentstringrequired

Full HTML string (or a fragment — it will be wrapped).

titlestring

Optional page title (defaults to "Uploaded Landing Page").

slugstring

Optional URL slug (lowercase, hyphens). Auto-generated from the title + date when omitted. Re-uploading with a slug you own updates that page in place.

Assign a custom domain (e.g. go.acme.com) to a published landing page. Requires an active paid or pay-as-you-go plan. No credits charged.

Parameters

slugstringrequired

The landing page slug

domainstringrequired

Custom domain (e.g. "go.acme.com", "landing.mybrand.com")

Check if DNS is configured for a landing page's custom domain. No credits charged.

Parameters

slugstringrequired

The landing page slug

Audiences & Targeting

Upload audience data (emails, phones, MAIDs, companies, a public CSV URL, or a private artifact id) to ad platforms. Supports inline pre-hashed identifiers, artifact-id references for >1k entries, and batch mode for Clay.com row-by-row workflows (staging is free, upload costs 10 credits — only on success). Requires i_have_consent=true confirming the customer has lawful basis under GDPR/CCPA and platform Customer Match terms for every identifier in the audience.

Parameters

platformstringrequired

Target platform - "google", "meta", "linkedin", etc.

audience_namestring

Name for the audience (e.g., "Clay - Q1 Enterprise Leads")

emailsstring

Comma-separated raw email addresses (will be SHA-256 hashed before upload).

hashed_emailsstring

Comma-separated SHA-256 hashed emails (lowercase hex).

phonesstring

Comma-separated raw phone numbers (will be normalized + SHA-256 hashed).

hashed_phonesstring

Comma-separated SHA-256 hashed phones (lowercase hex).

mobile_idsstring

Comma-separated mobile advertising IDs (IDFA / GAID, raw). Meta and TikTok require raw MADIDs (not hashed).

hashed_mobile_idsstring

Comma-separated SHA-256 hashed mobile IDs (Reddit/TikTok only — Meta drops these with a warning).

company_namesstring

Comma-separated company names (LinkedIn only)

company_domainsstring

Comma-separated company domains (Google B2B targeting, LinkedIn)

csv_pathstring

Local path to an audience CSV. Best for local/stdio MCP setups that share a filesystem with the file.

csv_urlstring

Public HTTP(S) URL to an audience CSV. Best for hosted MCP calls to mcp.synterai.com.

emails_artifact_idstring

Opaque id referring to a private payload of raw emails (one per line). Use for >1k entries.

hashed_emails_artifact_idstring

Same as above but for SHA-256 hashed emails.

phones_artifact_idstring

Artifact id for raw phone numbers (one per line, country-code prefixed).

hashed_phones_artifact_idstring

Artifact id for SHA-256 hashed phones.

mobile_ids_artifact_idstring

Artifact id for raw mobile advertising IDs (IDFA / GAID). Meta only.

audience_typestring

Default: EMAIL. Pre-hashed values are detected automatically from CSV column headers.

EMAILCOMPANYLOOKALIKE

account_idstring

Optional specific ad account ID

batch_actionstring

"stage" to add items to a batch (free), "finalize" to upload all staged items (10 credits, only on success).

stagefinalize

batch_keystring

Required with batch_action - stable identifier for the batch (e.g., "q1_leads_feb2026")

customer_file_sourcestring

Meta only. Origin of the audience data. Default: USER_PROVIDED_ONLY.

USER_PROVIDED_ONLYPARTNER_PROVIDED_ONLYBOTH_USER_AND_PARTNER_PROVIDED

i_have_consentboolean

Confirm the customer has lawful basis (GDPR Art. 6) and required consent under CCPA / Meta Custom Audience Terms / Google Customer Match Policy for every identifier in this audience.

Stage a hashed-PII payload (newline-delimited identifiers) in Synter's private artifact store and return an opaque artifact_id. Pass that id to sync_audience via *_artifact_id parameters. No credits charged. Use this instead of pasting hashed identifiers as inline tool args when you have more than ~500 entries.

Parameters

bodystringrequired

UTF-8 payload — for hashed-email/phone uploads, one SHA-256 hash per line (lowercase hex, 64 chars). For raw mobile advertising IDs (Meta), one MADID per line. Stored verbatim — pre-dedupe and pre-normalize before calling.

script_namestring

Name of the script that will consume the artifact. Cross-checked on read so a leaked id can't be redirected to another script.

meta_ads_create_audiencegoogle_ads_create_customer_matchgoogle_ads_create_standard_retargeting_audiencesgoogle_ads_create_website_visitor_audiencemicrosoft_ads_create_audiencetiktok_ads_create_audiencex_ads_create_audience

ttl_secondsnumber

How long the artifact lives before being swept (default 1 hour, max 24 hours).

i_have_consentboolean

Confirm the customer has lawful basis (GDPR Art. 6) and required consent under CCPA / Meta / Google Customer Match terms for every identifier in `body`.

Create a campaign targeting an existing audience (200 credits — campaign launch)

Parameters

platformstringrequired

Only "linkedin" is supported today (a single script creates the Campaign Group + Campaign + ad and attaches the audience atomically). For every other platform, create the campaign/ad group with that platform's native tool, then call attach_audience() to target it.

campaign_namestringrequired

Name for the campaign

audience_idstringrequired

The audience ID from sync_audience() result

daily_budgetnumber

Daily budget in USD (default: $25)

headlinestring

Ad headline text

descriptionstring

Ad description text

final_urlstring

Landing page URL

image_urlstring

URL of the creative image asset. Required for LinkedIn.

account_idstring

Optional specific ad account ID

List existing audiences on an ad platform (2 credits)

Parameters

platformstring

Ad platform

googlelinkedinmetareddittiktokmicrosofttrade_deskstackadaptamazon_dspx

account_idstring

Optional specific ad account ID

name_containsstring

Optional case-insensitive filter on audience name or id

Delete (or close) a custom/matched audience from an ad platform by audience_id. Use to clean up stale or errored (e.g. NOT_ENOUGH_MATCHES) audiences. Reddit and Google supported today. This is irreversible.

Parameters

platformstringrequired

Reddit or Google. Note: Google Ads has no hard-delete API for user lists, so this closes the list instead.

redditgoogle

audience_idstringrequired

The platform audience id to delete (e.g. Reddit "ca.123…", Google's numeric user list ID).

account_idstring

Optional specific ad account ID.

Attach (add), remove, or replace a matched audience on an existing campaign/ad-group/ad-set/line-item's targeting (5 credits). Supports linkedin, google, meta, tiktok, reddit, microsoft, stackadapt, x.

Parameters

campaign_idstringrequired

The campaign to modify. For linkedin and stackadapt this IS the targeting entity. For other platforms, audiences attach at the ad-group/ad-set/line-item level — pass that ID via ad_group_id instead.

audience_idstring

The platform's audience/user-list/custom-audience ID to attach (provide this OR segment_urn, linkedin only).

segment_urnstring

adSegment URN to attach (linkedin only, alternative to audience_id).

modestring

Default: add (merge in). Not every mode is supported on every platform yet.

addremovereplace

facetstring

LinkedIn-only targeting facet. Default: audienceMatchingSegments

audienceMatchingSegmentsdynamicSegments

platformstring

Ad platform.

linkedingooglemetatiktokredditmicrosoftstackadaptx

ad_group_idstring

The ad group / ad set / line item ID to target, for platforms that attach audiences below the campaign level. Falls back to campaign_id if omitted.

Build ML-based lookalike audience from seed customers (10 credits)

Parameters

seed_audiencestringrequired

Source audience ID or name

platformstringrequired

Target platform (GOOGLE, META, etc.)

expansion_factornumber

How much to expand (1-10x seed size)

Guardrails & Alerts

Arm or replace a campaign-specific automatic pause rule. Google Ads rules pause one exact campaign only after both the minimum age and spend threshold are met with zero conversions on one exact verified truth conversion action. Configuration is standing authorization for the future pause. No credits charged.

Parameters

account_idstringrequired

campaign_idstringrequired

conversion_action_idstringrequired

spend_thresholdnumberrequired

min_age_hoursnumber

platformstring

List campaign-specific automatic pause guardrails and their latest spend, conversion, decision, and verified-pause state. No credits charged.

No parameters required.

Disable a campaign-specific automatic pause guardrail. This does not change the campaign's current platform status. No credits charged.

Parameters

guardrail_idnumberrequired

Set a weekly ad spend alert — notifies via email, Slack, SMS, and/or WhatsApp when total spend exceeds threshold (free)

Parameters

thresholdnumberrequired

Weekly spend threshold in USD (e.g. 10000)

emailstringrequired

Email address for email alerts

phonestring

Phone number in E.164 format for SMS/WhatsApp (e.g. +15551234567)

notifystring

Comma-separated channels to use: email, slack, sms, whatsapp (default: all)

platformsstring

Comma-separated platforms to check (default: google,meta,reddit)

Autonomous Agents

Create an autonomous agent schedule that runs a Synter skill on a cron cadence (e.g. a budget-pacing / campaign-health monitor). Defaults to a read-only cross-platform pacing monitor every 4 hours that alerts via Slack and never moves money. Pass skill_slug + cron_expression to schedule any autonomous-capable skill (5 credits).

Parameters

project_idstring

Synter campaign/project UUID to scope the agent to. Optional but recommended.

skill_slugstring

Autonomous-capable skill to run. Defaults to "campaign-health-monitoring".

cron_expressionstring

5-field cron. Defaults to "0 */4 * * *" (every 4h).

namestring

Optional human label for the schedule.

descriptionstring

Optional description.

platformstring

Optional platform scope (e.g. "google", "meta").

approval_modestring

Default "none" for the pacing monitor, "required" otherwise.

requiredoptionalnone

notify_channelsstring

Comma-separated channels: email, slack, whatsapp, in_app. Defaults to "slack".

notify_on_completionboolean

Send a notification when each run finishes.

organization_idnumber

Optional workspace id (defaults to the API key's org).

Update an existing autonomous agent schedule — edit its rules (description), cadence, approval mode, notify channels, or end date — and/or apply a lifecycle action (stop, freeze, resume, skip_next, run_now). Only the fields passed are changed.

Parameters

schedule_idstringrequired

Schedule UUID from list_autonomous_schedules.

namestring

New human label.

descriptionstring

New description / operating rules the skill reads on each run.

platformstring

New platform scope (e.g. "google", "meta").

cron_expressionstring

New 5-field cron cadence.

approval_modestring

New approval mode.

requiredoptionalnone

notify_channelsstring

Comma-separated channels: email, slack, whatsapp, in_app.

notify_on_completionboolean

Send a notification when each run finishes.

ends_atstring

ISO-8601 end timestamp, or empty string to clear.

actionstring

Lifecycle action applied after any field edits.

stopfreezeresumeskip_nextrun_now

organization_idnumber

Optional workspace id (defaults to the API key's org).

List the workspace's autonomous agent schedules (pacing/health monitors, budget optimizers) with cadence, approval mode, next run, and latest run status (free).

Parameters

organization_idnumber

Optional workspace id (defaults to the API key's org).

Skills

Superseded by load_skill (still callable, not listed). List public Synter execution skills and platform SOPs (free)

No parameters required.

Load a public Synter execution skill or platform SOP; omit skill_slug to list them (free)

Parameters

skill_slugstring

The slug of the skill to load (e.g., 'customer-facing-product-updates'). Omit to list skills.

Growth & Company Research

Synter technology intelligence. resource: domain_technologies, technology_changes, trust_signals, sites, product_search, company_to_url, domain_keywords, account_usage. Covers the eight tech_intel_* tools (2 credits each).

Parameters

resourcestringrequired

Which read to run.

domain_technologiestechnology_changestrust_signalssitesproduct_searchcompany_to_urldomain_keywordsaccount_usage

domainstring

Domain (domain_technologies, trust_signals, domain_keywords).

domainsarray

Up to 16 domains (technology_changes).

companystring

Company name (company_to_url).

querystring

Natural-language audience (sites) or product query (product_search).

techstring

Technology name (sites).

keywordstring

Keyword (sites).

limitnumber

Result limit (sites, product_search).

countriesarray