RelayAPI

Ads

The runtime capability snapshot at GET /v1/ads/platforms is authoritative for core Meta, Google, LinkedIn, Pinterest, TikTok, and X operations; GET /v1/ads/accounts/{ad_account_id}/advanced-capabilities is authoritative for the advanced surface. All six networks have registered adapters and dedicated connection authority, but each exposes a different set of typed writes, reads, analytics, targeting, and audience operations. Durable report jobs are implemented only for TikTok and X, plus approval-gated LinkedIn reporting. Lead inbox ingestion, conversion delivery, forecasts, and keyword planning remain unsupported; lead-form and asset/catalog/messaging routes are capability-gated local projections of existing provider resources. See the Advertising Platforms guide. Unsupported and provider-approval-gated operations are rejected before provider I/O. Dedicated connection credential fields are write-only, validated with provider account discovery before persistence, and never returned.

Endpoints

MethodEndpointDescription
POSTUpload hashed users to audienceUpload hashed users to audience
POSTBoost an existing published postBoost an existing published post
DELETECancel an adCancel an ad
POSTCreate standalone ad with custom creativeCreate standalone ad with custom creative
POSTCreate custom audienceCreate custom audience
POSTCreate a campaignCreate a campaign
POSTValidate and store a dedicated advertising credentialValidate and store a dedicated advertising credential
POSTCreate Ad Conversion EventCreate Ad Conversion Event
POSTCreate Ad Conversion RuleCreate Ad Conversion Rule
POSTCreate Ad ReportCreate Ad Report
DELETEDelete audienceDelete audience
DELETECancel/archive campaignCancel/archive campaign
POSTDiscover provider ad accounts through a dedicated ad connectionDiscover provider ad accounts through a dedicated ad connection
POSTForecast Ad DeliveryForecast Ad Delivery
POSTGenerate Ad Keyword IdeasGenerate Ad Keyword Ideas
GETGet ad detailsGet ad details
GETGet ad analytics with daily breakdownGet ad analytics with daily breakdown
GETGet audience detailsGet audience details
GETGet campaign detailsGet campaign details
GETGet Ad LeadGet Ad Lead
GETGet Ad ReportGet Ad Report
GETGet Advanced Ad Account CapabilitiesGet Advanced Ad Account Capabilities
POSTLink Ad CatalogLink Ad Catalog
POSTLink Ad Creative AssetLink Ad Creative Asset
POSTLink Ad Lead FormLink Ad Lead Form
POSTLink Ad Messaging ExperienceLink Ad Messaging Experience
POSTLink Ad Product SetLink Ad Product Set
GETList dedicated provider ad accountsList dedicated provider ad accounts
GETList custom audiencesList custom audiences
GETList campaigns with aggregate metricsList campaigns with aggregate metrics
GETList dedicated advertising connectionsList dedicated advertising connections
GETList Ad Lead FormsList Ad Lead Forms
GETList Ad LeadsList Ad Leads
GETList truthful ad platform capabilitiesList truthful ad platform capabilities
GETList Ad Report ResultsList Ad Report Results
GETList adsList ads
POSTPromote Ad LeadPromote Ad Lead
DELETERevoke and shred an advertising credentialRevoke and shred an advertising credential
PUTValidate and rotate an advertising credentialValidate and rotate an advertising credential
GETSearch targeting interestsSearch targeting interests
POSTTrigger manual sync for an ad accountTrigger manual sync for an ad account
PATCHUpdate ad (name, budget, targeting, pause/resume)Update ad (name, budget, targeting, pause/resume)
PATCHUpdate campaign (pause/resume)Update campaign (pause/resume)

Found something wrong? Help us improve this page.

On this page