Scope3

Scope3 Advertisers API

Manage advertisers

GitHub OpenAPI

Operations 22

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /advertisers List advertisers · List advertisers #
Ask an LLM
“Which advertisers do I have set up in Scope3?”
“Can I filter my advertiser list to only sandbox advertisers?”
Tell an agent
List all my active advertisers.
Find advertisers whose name matches {name}.
POST /advertisers Create an advertiser · Create advertiser #
Ask an LLM
“How do I set up a new advertiser before creating campaigns?”
“What do I need to provide to create an advertiser, like brand and currency?”
Tell an agent
Create an advertiser named {name} for brand {brand} billed in {primaryCurrency}.
Set up a new sandbox advertiser called {name} with brand {brand} in {primaryCurrency}.
GET /all-advertisers-home Get the all-advertisers landing overview · List all advertisers home #
Ask an LLM
“Can I get a portfolio summary across all my advertisers with campaign counts?”
“Which of my advertisers have a resumable draft waiting?”
Tell an agent
Show me the all-advertisers home view with portfolio totals.
Pull the landing overview of every advertiser and its campaign count.
GET /advertisers/{advertiserId} Get an advertiser's details · Get advertiser #
Ask an LLM
“What brand details and ADCP manifest are stored for one of my advertisers?”
“Can I look up a single advertiser by its ID?”
Tell an agent
Get advertiser {advertiserId}.
Show the full brand details for advertiser {advertiserId}.
PUT /advertisers/{advertiserId} Update an advertiser · Update advertiser #
Ask an LLM
“Can I change an existing advertiser's frequency caps or UTM settings?”
“How do I rename an advertiser or change its primary currency?”
Tell an agent
Rename advertiser {advertiserId} to {name}.
Change the primary currency of advertiser {advertiserId} to {primaryCurrency}.
DELETE /advertisers/{advertiserId} Archive an advertiser · Delete advertiser #
Ask an LLM
“What happens when I delete an advertiser, is it archived?”
“Can I remove an advertiser I no longer run campaigns for?”
Tell an agent destructive · confirm first
Delete advertiser {advertiserId}.
Archive the advertiser {advertiserId}.
POST /advertisers/{advertiserId}/restore Restore an archived advertiser · Restore advertiser #
Ask an LLM
“Can I bring back an advertiser I archived by mistake?”
“Is a deleted advertiser recoverable?”
Tell an agent
Restore archived advertiser {advertiserId}.
Make deleted advertiser {advertiserId} active again.
POST /advertisers/{advertiserId}/data-delivery-credentials/{name}/validate Revalidate a data delivery credential · Revalidate data delivery credential #
Ask an LLM
“After fixing bucket access, how do I re-test my data delivery destination?”
“Why is my object-storage data delivery credential marked FAILED and can I recheck it?”
Tell an agent
Revalidate data delivery credential {name} on advertiser {advertiserId}.
Re-run the destination probe for credential {name} of advertiser {advertiserId}.
GET /advertisers/{advertiserId}/accounts List an advertiser's linked accounts · List advertiser accounts #
Ask an LLM
“Which sales-agent accounts are already linked to my advertiser?”
“Can I see only the linked accounts from one sales agent?”
Tell an agent
List the accounts linked to advertiser {advertiserId}.
Show accounts linked to advertiser {advertiserId} from storefront {storefrontId}.
POST /advertisers/{advertiserId}/accounts Link a partner account to an advertiser · Assign account #
Ask an LLM
“How do I connect a seller account I discovered to my advertiser?”
“Can I choose the billing type when linking a partner account?”
Tell an agent
Link account {accountId} from source {sourceId} on storefront {storefrontId} to advertiser {advertiserId}.
Assign partner account {accountId} to advertiser {advertiserId} via storefront {storefrontId} and source {sourceId}.
GET /advertisers/{advertiserId}/accounts/{accountId} Get one linked account on an advertiser · Get advertiser account #
Ask an LLM
“Can I check the details of a single sales-agent account linked to an advertiser?”
“What is stored for one particular linked account on my advertiser?”
Tell an agent
Get linked account {accountId} on advertiser {advertiserId}.
Show me account {accountId} as linked to advertiser {advertiserId}.
GET /advertisers/{advertiserId}/accounts/available Discover accounts available to link · List available accounts #
Ask an LLM
“Which seller accounts could I still link to my advertiser from a sales agent?”
“Can I force a fresh lookup of linkable accounts instead of cached results?”
Tell an agent
Find accounts available to link to advertiser {advertiserId} from storefront {storefrontId} source {sourceId}.
Refresh and list linkable accounts for advertiser {advertiserId} from source {sourceId} on storefront {storefrontId}.
DELETE /advertisers/{advertiserId}/accounts/{linkId} Unlink a partner account from an advertiser · Unmap a partner account from an advertiser #
Ask an LLM
“What happens to buys if I unmap a partner account from my advertiser?”
“Can I disconnect a linked seller account but keep its history?”
Tell an agent destructive · confirm first
Unlink account mapping {linkId} from advertiser {advertiserId}.
Remove partner account link {linkId} on advertiser {advertiserId}.
PUT /advertisers/{advertiserId}/accounts/{linkId}/reporting-bucket Set a linked account's reporting bucket · Update account reporting bucket #
Ask an LLM
“Can I configure an offline reporting bucket on a linked partner account?”
“How do I clear the reporting bucket on an account link?”
Tell an agent
Set the reporting bucket on link {linkId} of advertiser {advertiserId} to {reporting_bucket}.
Clear the reporting bucket for account link {linkId} on advertiser {advertiserId} by setting it to {reporting_bucket}.
GET /advertisers/{advertiserId}/catalogs List an advertiser's synced catalogs · List catalogs #
Ask an LLM
“Which product catalogs have been synced for my advertiser?”
“Can I filter synced catalogs by type?”
Tell an agent
List catalogs synced for advertiser {advertiserId}.
Show {type} catalogs for advertiser {advertiserId}.
POST /advertisers/{advertiserId}/catalogs/sync Sync catalogs and items to an advertiser · Sync catalogs #
Ask an LLM
“How do I push my product catalog feed into an advertiser?”
“Can I dry-run a catalog sync before applying it?”
Tell an agent
Sync catalogs {catalogs} for account {account} to advertiser {advertiserId}.
Dry-run syncing catalogs {catalogs} into advertiser {advertiserId} for account {account}.
PUT /advertisers/{advertiserId}/catalogs/{catalogId}/transform Save a catalog transform · Save catalog transform #
Ask an LLM
“How do I define the rules that map catalog items into campaign groups and budget hints?”
“Can I save a named transform for a catalog?”
Tell an agent
Save transform {transform} for catalog {catalogId} on advertiser {advertiserId}.
Set the active transform of catalog {catalogId} for advertiser {advertiserId} to {transform}, named {name}.
POST /advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview Preview a catalog activation plan · Preview catalog activation plan #
Ask an LLM
“Can I see what campaigns a catalog would produce before launching anything?”
“Is it possible to save the activation plan preview for later execution?”
Tell an agent
Preview the activation plan for catalog {catalogId} on advertiser {advertiserId}.
Build and save an activation plan preview for catalog {catalogId} of advertiser {advertiserId}.
POST /advertisers/{advertiserId}/catalogs/{catalogId}/refresh Refresh a URL-backed catalog feed · Refresh catalog #
Ask an LLM
“How do I pull the latest version of my URL-based catalog feed?”
“Can a catalog refresh also run the activation plan automatically?”
Tell an agent
Refresh catalog {catalogId} for advertiser {advertiserId}.
Refetch catalog {catalogId} of advertiser {advertiserId} and execute activation: {executeActivation}.
POST /advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/execute Execute a catalog activation plan · Execute catalog activation plan #
Ask an LLM
“What does executing a catalog activation plan create downstream?”
“Can I run a saved activation plan by its plan ID?”
Tell an agent
Execute activation plan {planId} for catalog {catalogId} on advertiser {advertiserId}.
Launch the catalog activation for catalog {catalogId} of advertiser {advertiserId}.
POST /advertisers/{accountId}/audiences/sync Sync first-party CRM audiences · Sync audiences #
Ask an LLM
“How do I upload my first-party CRM audiences?”
“Is audience syncing asynchronous, and can I get notified when it finishes?”
Tell an agent
Sync audiences {audiences} to my account.
Sync CRM audiences {audiences} and delete missing ones: {deleteMissing}.
GET /advertisers/{accountId}/audiences List stored audiences · List audiences #
Ask an LLM
“Which first-party audiences are stored on my account?”
“Can I page through my audience metadata?”
Tell an agent
List my stored audiences.
Show {take} audiences starting after {skip}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/scope3/refs/heads/main/openapi/scope3-advertisers-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/scope3:scope3-advertisers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

scope3-advertisers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Scope3 Buyer Advertisers API
  version: 2.0.0
  description: 'REST API for advertisers to manage advertisers, campaigns, and reporting.


    ## Authentication


    All endpoints require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer your-api-key

    ```


    ## Base URL


    `https://api.interchange.io/api/v2/buyer`


    ## For AI Agents


    AI agents can use the MCP endpoint at `/mcp/v2/buyer` with three tools:

    - `initialize`: Start an MCP session

    - `api_call`: Make REST API calls

    - `ask_about_capability`: Learn about API features'
servers:
- url: https://api.interchange.io/api/v2/buyer
  description: Production server
tags:


# --- truncated at 32 KB (223 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scope3/refs/heads/main/openapi/scope3-advertisers-api-openapi.yml