Scope3 Campaigns API
Manage advertising campaigns
Scope3 Campaigns API is one of 51 APIs that Scope3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 21 operations across 17 paths, and defines 99 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against a single base URL, https://api.interchange.io/api/v2/buyer.
21 operations
17 paths
99 schemas
1 DELETE11 GET1 PATCH7 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Scope3 Campaigns API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
bearerAuth— API key or access token
Paths & Operations 21
Across 17 paths, the API surfaces 21 operations — 1 DELETE, 11 GET, 1 PATCH, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Campaigns 21
Manage advertising campaigns
GET
/campaigns
List campaigns
POST
/campaigns
Create campaign
PUT
/campaigns/{campaignId}
Update campaign
GET
/campaigns/{campaignId}
Get campaign
DELETE
/campaigns/{campaignId}
Delete campaign
GET
/campaigns/{campaignId}/delivery
Get campaign delivery (alpha)
POST
/campaigns/{campaignId}/execute
Execute campaign
POST
/campaigns/{campaignId}/pause
Pause campaign
POST
/campaigns/{campaignId}/reactivate
Reactivate campaign
POST
/campaigns/{campaignId}/auto-select-products
Auto-select products
GET
/campaigns/{campaignId}/media-buy-status
Get media buy ADCP status
GET
/media-buys/{mediaBuyId}
Get media buy
PATCH
/media-buys/{mediaBuyId}
Update media buy
GET
/media-buys/{mediaBuyId}/packages
List media buy packages
POST
/media-buys/{mediaBuyId}/pause
Pause media buy
POST
/media-buys/{mediaBuyId}/reactivate
Reactivate media buy
GET
/campaigns/{campaignId}/products
Get campaign products
GET
/targeting/dimensions
List targeting dimensions
GET
/targeting/dimensions/{system}
List targeting dimension values
GET
/targeting/dimensions/{system}/resolve
Resolve targeting dimension text
GET
/targeting/geo-metros
List geo metros
Schemas 99
The contract defines 99 schemas that model the data the API accepts and returns. The most detailed are Campaign (31 properties), CampaignPackageTargetingOverlay (28 properties), CreateDiscoveryCampaignBody (18 properties), CreatePerformanceCampaignBody (18 properties). Each schema is shown below with its type and property counts.
StorefrontEndpointDirectedCampaignInfo
object
Provenance and dual-key identity for a direct buy through one storefront AdCP endpoint.
4 properties
3 required
ExecuteCampaignBody
object
Optional request body for executing a campaign. Unknown fields are rejected.
1 property
CreateDiscoveryCampaignBody
object
Request body for creating a discovery-mode campaign
18 properties
5 required
DeliveryConfigOutput
object
Per-Output destination shape (non-secret). Additional destination types are added as new variants in this discriminated union.
FrequencyCapWindow
object
Rolling time window over which maximpressions applies (AdCP Duration shape).
2 properties
2 required
CampaignStatusListFilter
string
Campaign statuses to include in the list, or "ALL" to include every status. Defaults to the non-terminal statuses (ACTIVE, DRAFT, PAUSED) — every campaign that…
BuyerMediaBuy
object
A single media buy with its optimization goals and why-visibility annotation (pendingReason, errorCode, forwardedAt, buyerReference). Use getcampaign for packa…
17 properties
5 required
UpdateLegacyCampaignBody
object
17 properties
UpdateCampaignOpenApiBody
ResolveTargetingDimensionResponse
object
Resolution candidates for localized targeting text within a dimension.
5 properties
5 required
CampaignCascadeResponse
object
Campaign cascade operation outcome, including the status change result for each media buy
8 properties
8 required
MediaBuyStatusChangeResponse
object
Response from pausing or reactivating a single media buy. Only this media buy is affected — its campaign is never cascaded.
6 properties
5 required
FrequencyCapConfigInput
object
Frequency cap entry supplied inside a parent advertiser/campaign/creative request body. On PUT, the full array replaces all existing caps for that target.
2 properties
2 required
Campaign
object
Campaign resource representation
31 properties
10 required
ErrorResponse
object
Standard error response
2 properties
2 required
PacingPeriods
object
Defines a pacing schedule for a campaign. Periods represent time windows with varying spend intensity. Gaps between periods are treated as pauses (no spend). U…
2 properties
2 required
EventGoal
object
Optimize for advertiser-tracked conversion events via event sources.
5 properties
2 required
UpdateMediaBuyRequest
object
Partial update for a single media buy, resolved top-level by mediaBuyId. Rejected outright (not warned) when it would violate a campaign invariant: currency (a…
8 properties
CampaignDataDeliveryInput
object
Campaign-scoped data-delivery configuration. Groups Data Delivery Outputs that override advertiser-scoped delivery for the same dataDeliveryType. Distinct from…
1 property
DeliveryConfig
object
Per-Output destination shape (non-secret). Additional destination types are added as new variants in this discriminated union.
CampaignPackageTargetingOverlay
object
Targeting carried on a campaign package; directed adapters populate provider-normalized readback when supported.
28 properties
PerformanceConfig
object
Configuration for performance campaign optimization
1 property
1 required
MediaBuyPendingReason
string
Why a not-yet-delivering media buy is waiting, and implicitly whose side owns the wait. A platform-derived annotation — never a status value. awaitingstorefron…
ConnectedAccountDirectedCampaignInfo
object
Subscription-backed directed campaign mirror state — connection, upstream account, dual-keyed identifiers, and sync health.
10 properties
7 required
DataDeliveryOutput
object
Resolved Data Delivery Output as returned by the API.
11 properties
10 required
CreativeReviewStatus
string
Lifecycle state of a buyer-submitted creative awaiting storefront review. pending until an operator decides; approved or rejected after a decision; revoked if…
Duration
object
A duration expressed as an interval and unit
2 properties
2 required
UpdateMediaBuyProductInput
object
Product update — additive (existing products not listed are preserved). Use remove: true to delete a product. Does not add brand-new product selections; use cr…
8 properties
1 required
CampaignUtmConfig
object
UTM configuration for a campaign. Overrides advertiser-level defaults for matching param keys.
2 properties
1 required
FrequencyCapTargetLevel
string
Level of the entity the frequency cap applies to
CampaignStorefrontRef
object
A storefront the campaign is pinned to, hydrated from the storefront IDs the buyer set on create/update.
3 properties
3 required
ListTargetingDimensionsResponse
object
Supported targeting dimensions and their campaign fields.
2 properties
2 required
RefinementItem
object
A single refinement directive (request-scoped or product-scoped)
BuyerPackageDelivery
object
Delivery recorded against this package. Absent when the package has not delivered or the source has not reported yet.
3 properties
3 required
MediaBuyPendingChange
object
A buyer-submitted change that has been accepted by Interchange but has NOT yet taken effect on the delivering buy. Its presence is the signal that this buy has…
4 properties
2 required
TargetingDimensionEntry
object
2 properties
2 required
DirectedCampaignDeliveryResponse
object
The campaign identifier and its owning connected seller or storefront's AdCP delivery response.
2 properties
2 required
MetricGoal
object
Optimize for a seller-tracked delivery metric. No event source required.
5 properties
2 required
CreatePerformanceCampaignBody
object
Request body for creating a performance-mode campaign
18 properties
6 required
TargetingDimensionSummary
object
6 properties
6 required
CampaignManagementFilter
string
Management states to include in the list: "tracked", "managed", or "all" (both — the default).
ExecuteWarning
object
A non-fatal outcome from campaign execution
AutoSelectProductsResponse
object
Response from auto-selecting products for a performance campaign
6 properties
5 required
UpdateDiscoveryCampaignBody
object
Request body for updating a discovery-mode campaign
17 properties
1 required
CampaignSearchContextSummary
object
Summary of a single discovery run within a campaign
6 properties
6 required
BuyerMediaBuyPackagesResponse
object
A media buy's packages with the attributes needed to pick one, sized to be read in full by an agent.
4 properties
4 required
GcsDeliveryConfig
object
3 properties
1 required
GetAdcpStatusOutput
object
10 properties
10 required
DirectedCampaignInfo
object
Directed campaign provenance. Connected-account campaigns expose mirror health; storefront-endpoint campaigns expose the addressed storefront and dual-key iden…
FrequencyCapConfig
object
Buyer-side frequency cap configuration
8 properties
7 required
DataDeliveryOutputArrayInput
array
Array of Data Delivery Outputs for one scope (advertiser or campaign). At most one Output per (dataDeliveryType, credentialName) pair — the same data type can…
PacingPeriodsOutput
object
Defines a pacing schedule for a campaign. Periods represent time windows with varying spend intensity. Gaps between periods are treated as pauses (no spend). U…
2 properties
2 required
ApiError
object
Structured error object
4 properties
2 required
S3DeliveryConfigOutput
object
3 properties
3 required
EventGoalOutput
object
Optimize for advertiser-tracked conversion events via event sources.
5 properties
2 required
MetricGoalOutput
object
Optimize for a seller-tracked delivery metric. No event source required.
5 properties
2 required
GeoMetrosResponse
object
Geo metro codes and English display labels for buyer-side display and input resolution.
3 properties
3 required
CampaignProductsResponse
object
Every product attached to a campaign, sourced from the campaign's media buys (authoritative) plus any discovery-staged products that have not yet been executed…
5 properties
5 required
TargetingDimensionSystem
string
Supported targeting dimension system
MediaBuyRef
object
Lightweight media buy reference (id + live status). Used in Campaign.mediaBuyRefs so callers can enumerate media buys without loading the full nested tree.
4 properties
2 required
OptimizationGoalOutput
object
A single optimization target. Either kind "event" (conversion events) or kind "metric" (seller-native delivery metric).
MediaBuyErrorOwner
string
Which party owns fixing the error: buyerinput (the request needs a correction from the buyer), platform (Scope3 owns the fault), seller (the storefront or its…
ExecuteMediaBuyDebugInfo
object
Full debug info including ADCP request, response, and A2A debug logs. Only present when debug=true. Same structure as v1 executemediabuy debug output.
4 properties
CampaignStatusChangeResponse
object
Response from executing or pausing a campaign
8 properties
4 required
BuyerPackage
object
One package on a media buy, carrying the attributes that identify it. Targeting, creatives, and format detail are deliberately omitted; use getcampaign for tho…
11 properties
4 required
OptimizationGoal
object
A single optimization target. Either kind "event" (conversion events) or kind "metric" (seller-native delivery metric).
AutoSelectProductsRequest
object
Optional refinement parameters for iterative auto-select product selection. Based on ADCP refine spec.
3 properties
UpdatePerformanceCampaignBody
object
Request body for updating a performance-mode campaign
17 properties
1 required
DurationOutput
object
A duration expressed as an interval and unit
2 properties
2 required
AzureBlobDeliveryConfigOutput
object
3 properties
3 required
AzureBlobDeliveryConfig
object
3 properties
1 required
BuyerMediaBuyErrorCode
string
Buyer-safe structured error code for a media buy that failed to forward or was rejected. Paired with errorOwner (who owns the fix) and, when the source provide…
S3DeliveryConfig
object
3 properties
1 required
CampaignMode
string
Who is steering the campaign. "discovery" (brief-driven) and "performance" (objective-driven) are platform-managed. "directed" is a deprecated wire value retai…
CampaignSummary
object
Compact campaign view returned by list endpoints. Use getcampaign for the full resource.
13 properties
8 required
TargetingDimensionResolveCandidate
object
7 properties
7 required
OptimizationAttributionWindowOutput
object
Attribution window for conversion optimization
2 properties
1 required
GcsDeliveryConfigOutput
object
3 properties
3 required
TargetingDimensionValuesResponse
object
Targeting dimension codes and localized display labels for buyer-side display and input resolution.
6 properties
6 required
MediaBuyCascadeResult
object
Outcome of a single media buy status change in the cascade
5 properties
4 required
CampaignDataDelivery
object
Resolved data-delivery configuration for this campaign. Groups standing Data Delivery Outputs (with advertiser/campaign-scoped overrides applied). Distinct fro…
1 property
ProviderTargetingReadback
object
Provider-normalized geographic, demographic, and audience targeting readback. Audience fields contain canonical buyer IDs, never native provider IDs. Only cano…
14 properties
4 required
UpdateMediaBuyResponse
object
The updated media buy (why-visibility fields included) plus any non-blocking warnings.
2 properties
1 required
ExecutionError
object
Structured error detail for a failed media buy execution
4 properties
3 required
OptimizationApplyMode
string
Whether optimization suggestions are automatically applied or require human approval.
OptimizationAttributionWindow
object
Attribution window for conversion optimization
2 properties
1 required
CampaignListResponse
object
Response containing a paginated list of campaign summaries
7 properties
3 required
DataDeliveryOutputInput
object
A single Data Delivery Output entry. Used inline on advertiser/campaign create+update.
6 properties
4 required
CampaignManagement
string
Whether the platform acts on this campaign. "tracked" = a campaign the platform did not set up, mirrored from a connected seller account: the shell is derived…
BuyerMediaBuyResponse
object
Response containing a single media buy with why-visibility
1 property
1 required
UpdateMediaBuyPackageInput
object
Per-package update for a media buy with deployed packages
7 properties
1 required
PackagePacingPeriod
object
Which pacing period a package was cut for. This is what the numeric suffix on a storefront-minted package id refers to: package ids are assigned in product-the…
2 properties
1 required
MediaBuyRefPendingChange
object
Present when this buy has a submitted change that has not yet reached the delivering buy. Call getmediabuy for the field-level differences; this reference stay…
2 properties
1 required
PerformanceConfigOutput
object
Configuration for performance campaign optimization
1 property
1 required
CampaignGeoMetroNames
array
Display labels for metro codes. Returned only when requested with fields=geometronames; labels are derived from the local geo-metro label table and are not acc…
CampaignProductEntry
object
A product staged on a campaign with discovery and execution context
13 properties
4 required
CampaignResponse
object
Response containing a single campaign
2 properties
1 required
CreateCampaignOpenApiBody
object
RefreshDirectedCampaignBody
object
Request body for refreshing a directed campaign mirror without an upstream mutation.
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Scope3 12
Other APIs Scope3 publishes across the network.
Scope3 AI Impact Measurement API
Scope3 Benchmarks API
Scope3 Creative API
Scope3 Data API
Scope3 Gpu API
Scope3 Impact API
Scope3 Measure API
Scope3 Model API
Scope3 Node API
Scope3 Reload API
Scope3 Saved Lists API
Scope3 Segment API
#Campaigns
Where this information came from
This is an independent, third-party profile of Scope3 Campaigns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.