Skip to main content

Endpoints

Method

Endpoint

Description

POST

/accounts/{accountId}/campaigns

Create a new campaign for the specified account.

GET

/accounts/{accountId}/campaigns

Retrieve all campaigns associated with the specified account.

GET

/campaigns/{campaignId}

Retrieve details of a specific campaign by its ID.

PUT

/campaigns/{campaignId}

Update details of a specific campaign by its ID.

Create Operations:
  • When using the POST method to create a resource, all Required fields must be included. Any Optional fields that are omitted will be set to their default values.
Update Operations:
  • When using the PUT method to update a resource, all Write fields can be specified. Omitting any of these fields is treated as setting them to null, where applicable.

Campaign Attributes

Attribute

Data Type

Description

id

string

Campaign ID, generated internally by Criteo

Accepted values: int64

Writeable? N / Nullable? N

accountId

string

AccountID associated with the campaign, generated internally by Criteo

Accepted values: int64

Writeable? N / Nullable? N

name*

string

Campaign name; must be unique within anAccount

Accepted values: up to 255-chars string

Writeable? Y / Nullable? N

type

enum

Campaign type

If the attribute is passed in the call, a value must be specified

Accepted values:auction,preferred

Default:auction

Writeable? Y / Nullable? N

budget

decimal

Campaign lifetime spend cap; uncapped if omitted or set tonull.

Note that preferred campaign types cannot have budgets as these campaign types must be uncapped

Accepted values: equals/greater than zero

Default:null

Writeable? Y / Nullable? Y

budgetSpent

decimal

Amount the campaign has already spent

Accepted values: equals/greater than zero

Default:0.0

Writeable? N / Nullable? N

budgetRemaining

decimal

Amount the campaign has remaining until cap is hit;nullif budget is uncapped

Accepted values: between zero andbudget

Default:null

Writeable? N / Nullable? Y

promotedBrandIds

list<string>

List of brand IDs from promoted products in the campaign, originated from the retailer’sCatalog

  • see also
Brands

Accepted values: list of strings

Default: empty list

Writeable? N / Nullable? N

clickAttributionWindow

enum

Post-click attribution window

Accepted values:7D,14D,30D

Default:30D

Writeable? Y / Nullable? N

viewAttributionWindow

enum

Post-view attribution window

Accepted values:None,1D,7D,14D,30D

Default:none

Writeable? Y / Nullable? N

clickAttributionScope

enum

Post-click attribution scope

Accepted values:sameSku,sameSkuCategory,sameSkuCategoryBrand

Default:sameSkuCategory

Writeable? Y / Nullable? N

viewAttributionScope

enum

Post-view attribution scope

Accepted values:sameSku,sameSkuCategory,sameSkuCategoryBrand

Default:sameSku

Writeable? Y / Nullable? N

drawableBalanceIds

list<string>

List ofBalancesthe campaign is able to draw from; at least one balance is required for a campaign to start

Accepted values: list ofbalanceId

Default: empty list

Writeable? Y / Nullable? N

status

enum

Campaign status, derived from the status ofLine Itemsit holds;activeif at least one line item is active.

Accepted values:active,inactive

Default:inactive

Writeable? N / Nullable? N

monthlyPacing

decimal

The maximum monthly spend allowed for the campaign in the currency of the account. The spend is constrained by remaining account balance and total budget of the campaign. Monthly budget spend reset monthly at the start of the month based on the account timezone

Accepted values:nullor greater than zero

Default:null

Writeable? Y / Nullable? Y

dailyPacing

decimal

The maximum daily spend allowed for the campaign in the currency of the account, as long as not set tonullandisAutoDailyPacing = false; otherwise no daily spend limit will be enforced

Accepted values:nullor greater than zero

Default:null

Writeable? Y / Nullable? Y

isAutoDailyPacing*

boolean

Auto daily pacing flag for the campaign budget. The daily pacing value is automatically calculated with respect to the days left in the month for the account. The campaign’s remaining account balance, total budget, and monthly pacing value are constrained by account’s timezone and the campaign status. If auto daily pacing is enabled,dailyPacingvalue should be left empty (null).

Note the value may be affected by budget override. Daily budget spend is reset daily at the start of the day based on the account timezone. To activate, either campaign’sendDateandbudgetormonthlyPacingmust be specified, overwritingdailyPacingwith the new respective pace (if not set previously)

Accepted values:true,false

Writeable? Y / Nullable? N

startDate

timestamp

Campaign start date. The campaign starts inactive if invalid start date is not today or end date is in previous day.

Accepted values:yyyy-mm-ddThh:mm:ss±hh:mm(inISO-8601)

Default: creation timestamp

Writeable? Y / Nullable? Y

⚠️Note: if time/timezone designators are not provided, the default value to be considered will be00:00:00+00:00(i.e., midnight in UTC - account timezone not taken in consideration here)

endDate

timestamp

Campaign end date. The campaign starts inactive if invalid start date is not today or end date is in previous day

Accepted values:yyyy-mm-ddThh:mm:ss±hh:mm(inISO-8601)

Default:null

Writeable? Y / Nullable? Y

⚠️Note: if time/timezone designators are not provided, the default value to be considered will be00:00:00+00:00(i.e., midnight in UTC - account timezone not taken in consideration here)

createdAt

timestamp

Timestamp of campaign creation, in UTC

Accepted values:yyyy-mm-ddThh:mm:ss±hh:mm(inISO-8601)

Writeable? N / Nullable? N

updatedAt

timestamp

Timestamp of last campaign update, in UTC

Accepted values:yyyy-mm-ddThh:mm:ss±hh:mm(inISO-8601)

Writeable? N / Nullable? N

companyName

string

This optional field, exclusively accessible to marketplaces within the European Union (in compliance with the Digital Service Act - DSA), will display the name of the company associated with the advertisement.

Accepted values: up to 255-chars string

Writeable? Y / Nullable? Y

onBehalfCompanyName

string

This optional field, exclusively accessible to marketplaces within the European Union (in compliance with the Digital Service Act - DSA), will display the name of the company (on behalf ofcompanyName) associated with the advertisement

Accepted values: up to 255-chars string

Writeable? Y / Nullable? Y

retailerId

string

The retailer this campaign is associated with.

Required when using a retailer budget balance.

Writeable? Y (at create) / Nullable? Y (for non-retailer-budget campaigns)

(*) Required for create operations

Digital Service Act (DSA)

In compliance with the Digital Services Act (DSA), marketplaces within the European Union will receive information about the company name associated with each advertisement.

Create a Campaign

This endpoint creates a Sponsored Products (type: auction) or Onsite Display (type: preferred) campaign. Retailer budget vs Criteo budget: Including retailerId in the request creates a retailer budget campaign. Omitting retailerId (or setting it to null) creates a standard Criteo budget campaign — retailerId will be null in the response. Balance mapping at create time: You may optionally include drawableBalanceIds to map the campaign to one or more retailer budget balances at creation. All compatibility rules apply (same retailer, same billing type, same demand account). You can also map balances separately after creation using POST /balances/{balanceId}/campaigns/append.
Note on 403 vs 400A 403 on campaign create means the retailerId you set is not recognized as an authorized retailer for your account. A 400 with a specific mismatch code means the retailer is valid but incompatible with the balance you included (see Error responses).Legacy version behavior (2025-10 and earlier): Returns 400 when attempting to create a retailer budget campaign.
Retailer Budgets CampaignsWhen creating a campaign for a retailer-budget balance, retailerId must be provided and must match the retailerId of the balance. Mismatched values will return a RetailerMismatchWithBalance error. Learn more about Retailer budgets here.
Sample Request
cURL
Sample Response

Get All Campaigns by Account ID

This endpoint returns all campaigns for an account.
As of 2026-01, retailerId is included in each campaign’s attributes. Use the retailerId query parameter to filter campaigns by retailer.Legacy version behavior (2025-10 and earlier): Retailer budget campaigns are not returned; retailerId is not present in the attribute set.
Results are paginated using pageIndex and pageSize query parameters; if omitted, defaults to 0 and 25, respectively. See API Response. Sample Request
cURL
Sample Response

Get a Specific Campaign

This endpoint retrieves the specified campaign.
As of 2026-07, retailerId is included in the response attributes. Retailer budget campaigns also surface criteoPoNumber and retailerPoNumber from the mapped balance.Legacy version behavior (2026-01 and earlier): Returns 400 for retailer budget campaigns.
Sample Request
cURL
Sample Response

Update a Specific Campaign

This endpoint allows you to update a specified campaign. The following example demonstrates how to switch to an uncapped campaign budget and modify the post-view attribution window.
Legacy version behavior (2025-10 and earlier): Returns 400 for retailer budget campaigns.
Sample Request
cURL
Sample Response

Responses

All validation errors on campaign create use code: "validation-error".The error type is identified by a bracketed prefix in the title field.