Criteo
App · 25 actions
Run Criteo campaigns from your workflows: change budgets and bids, start and stop ad sets, keep contact lists and audiences up to date, pull performance reports, and start workflows when campaigns appear, ad sets change status or daily spend passes an amount.
Actions
| Action | What it does |
|---|---|
| Add people to contact list | Add people to a contact list by email, phone number or another identifier. |
| Create audience | Build an audience from segments: people in any (or all) of the segments you include, less those in the ones you leave out. |
| Create contact list | Create an empty contact list segment for an advertiser, to fill with 'Add people to contact list'. |
| Delete audience | Delete an audience. |
| Delete audience segment | Delete an audience segment, such as a contact list. |
| Empty contact list | Take everyone off a contact list. |
| Get ad set | Get one ad set with its status, schedule, bid, budget and targeting. |
| Get campaign | Get one campaign with its goal, spend limit and budget automation. |
| Get contact list statistics | See how many identifiers a contact list holds and how many of them Criteo matched to people it can show ads to. |
| Get creative | Get one creative with its format, status, images or tags and landing page. |
| Get statistics report | Report on campaign performance (spend, impressions, clicks, sales, revenue and more) between two dates, broken down by day, campaign, ad set or other dimensions. |
| List ads | List an advertiser's ads with the creative and ad set each joins, its dates and whether it is live. |
| List advertisers | List the advertisers that have approved this connection's app, with their IDs and names. |
| List creatives | List an advertiser's creatives (the artwork ads show) with their format and status. |
| Remove people from contact list | Take people off a contact list by email, phone number or another identifier. |
| Search ad sets | List ad sets with their status, schedule, bid, budget and targeting, for some advertisers, campaigns or ad sets, or every one the app can reach. |
| Search audience segments | List audience segments (the groups of people audiences are built from), by advertiser, type or ID. |
| Search audiences | List audiences with the ad sets that target them, by advertiser, audience, ad set or segment. |
| Search campaigns | List campaigns with their goal and spend limit, for some advertisers or campaigns, or every one the app can reach. |
| Set campaign spend limit | Cap what a campaign may spend each day, each month or over its lifetime, or remove the cap. |
| Start ad set | Turn an ad set on, so it delivers (and spends) within its schedule and budget. |
| Stop ad set | Turn an ad set off, so it stops delivering and spending. |
| Target ad set at audience | Make an ad set show its ads to an audience (built from segments with 'Create audience'), in place of the one it targets now. |
| Update ad set | Change an ad set's name, bid, budget, start or end. |
| Update audience segment | Rename an audience segment or change its description. |
Add people to contact list
Add people to a contact list by email, phone number or another identifier. Criteo updates audiences twice a day, so ads reach them within hours.
Inputs
- Contact list
segment_idtextRequired - The contact list segment. Pick one, or give its ID from 'Create contact list' or an earlier step.
- Identifier type
identifier_typetext - What the people are given as. Emails may be plain or hashed (MD5, SHA-256); phone numbers need their country code, like +33... Defaults to email.One of:
email(Email address (plain or hashed)),phoneNumber(Phone number),madid(Mobile advertising ID),identityLink(LiveRamp IdentityLink),gum(Criteo GUM ID). Default:email. - People
identifierslistRequired - The identifiers, all of the type chosen, up to 50,000.
- GUM caller ID
gum_caller_idtext - Only for GUM IDs: the caller ID your Criteo account team gave you.Only when Identifier type is Criteo GUM ID.
Outputs
identifier_typetext- The identifier type
invalid_countnumber- How many it couldn't read
operationtext- add or remove
requested_attext- When Criteo took the change
sample_invalidlist- Some of those it couldn't read
segment_idtext- The contact list
valid_countnumber- How many identifiers Criteo accepted
Example output
{
"identifier_type": "email",
"invalid_count": 0,
"operation": "add",
"requested_at": "2026-12-10T10:00:50.000Z",
"sample_invalid": [],
"segment_id": "1001",
"valid_count": 2
}Create audience
Build an audience from segments: people in any (or all) of the segments you include, less those in the ones you leave out. Then target an ad set at it.
Inputs
- Advertiser
advertiser_idtextRequired - The advertiser. Pick one, or give its ID from an earlier step.
- Name
nametextRequired - The audience's name.
- Segments to include
include_segment_idslistRequired - The segments whose people it reaches.
- People who are
matchtext - With several segments to include: people in any of them, or only those in all. Defaults to any.One of:
any(In any of the segments),all(In all of the segments). Default:any. - Segments to leave out
exclude_segment_idslist - People in any of these are left out.
- Description
descriptiontext - A note about who it reaches.
Outputs
audienceobject- The new audience
Example output
{
"audience": {
"adSetIds": [],
"advertiserId": "4949",
"algebra": {
"and": [
{
"or": [
{
"audienceSegmentId": "42914"
},
{
"audienceSegmentId": "19234"
}
]
},
{
"not": {
"audienceSegmentId": "3482"
}
}
]
},
"createdAt": "2026-07-04T00:00:00Z",
"description": "An audience which targets people of interest",
"id": "1001",
"name": "My audience",
"updatedAt": null
}
}Create contact list
Create an empty contact list segment for an advertiser, to fill with 'Add people to contact list'.
Inputs
- Advertiser
advertiser_idtextRequired - The advertiser. Pick one, or give its ID from an earlier step.
- Name
nametextRequired - The contact list's name, unique for the advertiser.
- Description
descriptiontext - A note about who is on it.
Outputs
segmentobject- The new segment
Example output
{
"segment": {
"advertiserId": "4949",
"contactList": {
"isReadOnly": false
},
"createdAt": "2026-05-09T16:30:50.4633333",
"description": "Contact list description",
"id": "1001",
"name": "My contact list segment",
"type": "ContactList",
"updatedAt": null
}
}Delete audience
Delete an audience. Its segments stay.
Inputs
- Audience
audience_idtextRequired - The audience. Pick one, or give its ID from an earlier step.
Outputs
audience_idtext- The audience deleted
deletedtrue/false- True once deleted
Example output
{
"audience_id": "1001",
"deleted": true
}Delete audience segment
Delete an audience segment, such as a contact list. Segments made by Criteo can't be deleted.
Inputs
- Segment
segment_idtextRequired - The audience segment's ID, from 'Search audience segments' or an earlier step. Contact lists are offered to pick from.
Outputs
deletedtrue/false- True once deleted
segment_idtext- The segment deleted
Example output
{
"deleted": true,
"segment_id": "1001"
}Empty contact list
Take everyone off a contact list. The list itself stays, ready to fill again.
Inputs
- Contact list
segment_idtextRequired - The contact list segment. Pick one, or give its ID from 'Create contact list' or an earlier step.
Outputs
clearedtrue/false- True once emptied
segment_idtext- The contact list
Example output
{
"cleared": true,
"segment_id": "1001"
}Get ad set
Get one ad set with its status, schedule, bid, budget and targeting.
Inputs
- Ad set
ad_set_idtextRequired - The ad set. Pick one, or give its ID from an earlier step.
Outputs
activation_statustext- on or off: whether it is set to deliver
ad_setobject- The ad set
budget_amountnumber- The budget in the advertiser's currency, empty if no limit
delivery_statustext- Whether it delivers, such as live, paused, scheduled or ended
Example output
{
"activation_status": "on",
"ad_set": {
"adSetType": "standard",
"advertiserId": "12345",
"attributionConfiguration": {
"attributionMethod": "criteoAttribution",
"lookbackWindow": null
},
"bidding": {
"bidAmount": 0.9,
"costController": "maxCPC"
},
"budget": {
"budgetAmount": 123.45,
"budgetDeliverySmoothing": "standard",
"budgetDeliveryWeek": "mondayToSunday",
"budgetRenewal": "weekly",
"budgetStrategy": "capped",
"pacingBehavior": "targetFullBudget"
},
"campaignId": "99999",
"datasetId": "6789",
"destinationEnvironment": "web",
"id": "123467",
"mediaType": "display",
"name": "Campaign A",
"objective": "conversions",
"schedule": {
"activationStatus": "on",
"deliveryStatus": "live",
"endDate": {
"value": null
},
"startDate": {
"value": "2026-11-13T00:00:00Z"
}
},
"scheduledBudgets": [],
"targeting": {
"deliveryLimitations": {
"devices": [
"mobile",
"tablet",
"desktop"
]
},
"frequencyCapping": {
"frequency": "hourly",
"maximumImpressions": 3
},
"geoLocation": {
"countries": {
"operand": "in",
"values": [
"FR"
]
}
}
},
"videoChannel": null
},
"budget_amount": 123.45,
"delivery_status": "live"
}Get campaign
Get one campaign with its goal, spend limit and budget automation.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its ID from an earlier step.
Outputs
campaignobject- The campaign
spend_limit_amountnumber- The spend limit in the advertiser's currency, empty if none
spend_limit_renewaltext- daily, monthly or lifetime; undefined if no limit
spend_limit_typetext- capped or uncapped
Example output
{
"campaign": {
"advertiserId": "12345",
"budgetAutomation": {
"automatedBudgetConfiguration": null,
"enabled": false
},
"goal": "retention",
"id": "99999",
"name": "My Campaign",
"scheduledSpendLimits": [],
"sellerId": null,
"spendLimit": {
"spendLimitAmount": {
"value": 123.45
},
"spendLimitRenewal": "daily",
"spendLimitType": "capped"
}
},
"spend_limit_amount": 123.45,
"spend_limit_renewal": "daily",
"spend_limit_type": "capped"
}Get contact list statistics
See how many identifiers a contact list holds and how many of them Criteo matched to people it can show ads to.
Inputs
- Contact list
segment_idtextRequired - The contact list segment. Pick one, or give its ID from 'Create contact list' or an earlier step.
Outputs
match_ratenumber- The share matched, from 0 to 1
number_of_identifiersnumber- How many identifiers it holds
number_of_matchesnumber- How many Criteo matched to people
segment_idtext- The contact list
Example output
{
"match_rate": 0.5,
"number_of_identifiers": 1000,
"number_of_matches": 500,
"segment_id": "1001"
}Get creative
Get one creative with its format, status, images or tags and landing page.
Inputs
- Creative
creative_idtextRequired - The creative. Pick one, or give its ID from 'List creatives' or an earlier step.
Outputs
creativeobject- The creative
Example output
{
"creative": {
"adaptiveAttributes": null,
"advertiserId": "51",
"author": "r.deckard",
"datasetId": "49",
"description": "Description of the creative",
"dynamicAttributes": null,
"format": "Image",
"htmlTagAttributes": null,
"id": "18",
"imageAttributes": {
"landingPageUrl": "https://my-landing-page.com",
"urls": [
"https://static.criteo.net/image_1.jpg"
]
},
"name": "My image",
"showcaseAttributes": null,
"status": "Live",
"vastTagAttributes": null
}
}Get statistics report
Report on campaign performance (spend, impressions, clicks, sales, revenue and more) between two dates, broken down by day, campaign, ad set or other dimensions. One row per combination, with totals.
Inputs
- Advertisers
advertiser_idslistRequired - The advertisers to report on.
- From
start_datedateRequired - The first day to include.
- To
end_datedateRequired - The last day to include.
- Break down by
dimensionslistRequired - One row per combination of these. Picking an ID such as Campaign adds its name too.One or more of:
Day,Hour,Week,Month,Year,AdvertiserId(Advertiser),CampaignId(Campaign),AdsetId(Ad set),AdId(Ad),CouponId(Coupon), and 6 more. - Metrics
metricslistRequired - What to measure. Fewer than 40 keeps it quick.One or more of:
Displays(Impressions),Clicks,AdvertiserCost(Spend),ClickThroughRate(Click-through rate),Cpc(Cost per click),ECpm(Cost per thousand impressions),SalesPc30dPv24h(Sales (30-day click, 1-day view)),SalesPc7d(Sales (7-day click)),SalesClientAttribution(Sales (your own attribution)),RevenueGeneratedPc30dPv24h(Revenue (30-day click, 1-day view)), and 24 more. - Currency
currencytextRequired - The currency amounts are reported in.One of:
EUR,USD,GBP,CHF,JPY,BGN,CZK,DKK,HUF,LTL, and 99 more. - Time zone
time_zonetext - The time zone days are counted in, such as Europe/Paris. Defaults to UTC.
- Ad sets
ad_set_idslist - Only these ad sets. Leave empty for every ad set.
Outputs
columnslist- The column names, in Criteo's order
currencytext- The currency
end_datetext- The last day
row_countnumber- How many rows
rowslist- One row per combination, keyed by Criteo's column names (Day, CampaignId, Campaign, Clicks, AdvertiserCost...)
start_datetext- The first day
totalsobject- Each metric added up over every row
Example output
{
"columns": [
"Day",
"Currency",
"Displays",
"Clicks",
"AdvertiserCost"
],
"currency": "USD",
"end_date": "2026-11-11",
"row_count": 2,
"rows": [
{
"AdvertiserCost": 41.2,
"Clicks": 35,
"Currency": "USD",
"Day": "2026/11/10",
"Displays": 2534
},
{
"AdvertiserCost": 102.75,
"Clicks": 96,
"Currency": "USD",
"Day": "2026/11/11",
"Displays": 6234
}
],
"start_date": "2026-11-10",
"totals": {
"AdvertiserCost": 143.95,
"Clicks": 131,
"Displays": 8768
}
}List ads
List an advertiser's ads with the creative and ad set each joins, its dates and whether it is live. Gets one page; to see more, run it again skipping the ones you have.
Inputs
- Advertiser
advertiser_idtextRequired - The advertiser. Pick one, or give its ID from an earlier step.
- Page size
limitnumber - How many to return, 1 to 100. Criteo's default is 50.From 1 to 100.
- Skip
offsetnumber - How many to skip, to read the next page (for example 50).At least 0.
Outputs
adslist- The ads
countnumber- How many came back
Example output
{
"ads": [
{
"adDeliveryStatus": "Live",
"adSetId": "345",
"creativeId": "18",
"description": "Description of my first ad",
"endDate": "2026-10-08T08:47:30.000Z",
"id": "15",
"inventoryType": "Display",
"name": "My first ad",
"startDate": "2026-09-08T08:47:30.000Z"
}
],
"count": 1
}List advertisers
List the advertisers that have approved this connection's app, with their IDs and names.
Inputs
None.
Outputs
advertiserslist- The advertisers
countnumber- How many came back
Example output
{
"advertisers": [
{
"id": "12345",
"name": "Acme Shoes"
}
],
"count": 1
}List creatives
List an advertiser's creatives (the artwork ads show) with their format and status. Gets one page; to see more, run it again skipping the ones you have.
Inputs
- Advertiser
advertiser_idtextRequired - The advertiser. Pick one, or give its ID from an earlier step.
- Page size
limitnumber - How many to return, 1 to 100. Criteo's default is 50.From 1 to 100.
- Skip
offsetnumber - How many to skip, to read the next page (for example 50).At least 0.
Outputs
countnumber- How many came back
creativeslist- The creatives
Example output
{
"count": 1,
"creatives": [
{
"adaptiveAttributes": null,
"advertiserId": "51",
"author": "r.deckard",
"datasetId": "49",
"description": "Description of the creative",
"dynamicAttributes": null,
"format": "Image",
"htmlTagAttributes": null,
"id": "18",
"imageAttributes": {
"landingPageUrl": "https://my-landing-page.com",
"urls": [
"https://static.criteo.net/image_1.jpg"
]
},
"name": "My image",
"showcaseAttributes": null,
"status": "Live",
"vastTagAttributes": null
}
]
}Remove people from contact list
Take people off a contact list by email, phone number or another identifier.
Inputs
- Contact list
segment_idtextRequired - The contact list segment. Pick one, or give its ID from 'Create contact list' or an earlier step.
- Identifier type
identifier_typetext - What the people are given as. Emails may be plain or hashed (MD5, SHA-256); phone numbers need their country code, like +33... Defaults to email.One of:
email(Email address (plain or hashed)),phoneNumber(Phone number),madid(Mobile advertising ID),identityLink(LiveRamp IdentityLink),gum(Criteo GUM ID). Default:email. - People
identifierslistRequired - The identifiers, all of the type chosen, up to 50,000.
- GUM caller ID
gum_caller_idtext - Only for GUM IDs: the caller ID your Criteo account team gave you.Only when Identifier type is Criteo GUM ID.
Outputs
identifier_typetext- The identifier type
invalid_countnumber- How many it couldn't read
operationtext- add or remove
requested_attext- When Criteo took the change
sample_invalidlist- Some of those it couldn't read
segment_idtext- The contact list
valid_countnumber- How many identifiers Criteo accepted
Example output
{
"identifier_type": "email",
"invalid_count": 0,
"operation": "remove",
"requested_at": "2026-12-10T10:00:50.000Z",
"sample_invalid": [],
"segment_id": "1001",
"valid_count": 2
}Search ad sets
List ad sets with their status, schedule, bid, budget and targeting, for some advertisers, campaigns or ad sets, or every one the app can reach.
Inputs
- Advertisers
advertiser_idslist - Only these advertisers. Leave empty for every advertiser.
- Campaigns
campaign_idslist - Only these campaigns. Leave empty for every campaign.
- Ad sets
ad_set_idslist - Only these ad sets. Leave empty for every ad set.
Outputs
ad_setslist- The ad sets
countnumber- How many came back
Example output
{
"ad_sets": [
{
"adSetType": "standard",
"advertiserId": "12345",
"attributionConfiguration": {
"attributionMethod": "criteoAttribution",
"lookbackWindow": null
},
"bidding": {
"bidAmount": 0.9,
"costController": "maxCPC"
},
"budget": {
"budgetAmount": 123.45,
"budgetDeliverySmoothing": "standard",
"budgetDeliveryWeek": "mondayToSunday",
"budgetRenewal": "weekly",
"budgetStrategy": "capped",
"pacingBehavior": "targetFullBudget"
},
"campaignId": "99999",
"datasetId": "6789",
"destinationEnvironment": "web",
"id": "123467",
"mediaType": "display",
"name": "Campaign A",
"objective": "conversions",
"schedule": {
"activationStatus": "on",
"deliveryStatus": "live",
"endDate": {
"value": null
},
"startDate": {
"value": "2026-11-13T00:00:00Z"
}
},
"scheduledBudgets": [],
"targeting": {
"deliveryLimitations": {
"devices": [
"mobile",
"tablet",
"desktop"
]
},
"frequencyCapping": {
"frequency": "hourly",
"maximumImpressions": 3
},
"geoLocation": {
"countries": {
"operand": "in",
"values": [
"FR"
]
}
}
},
"videoChannel": null
}
],
"count": 1
}Search audience segments
List audience segments (the groups of people audiences are built from), by advertiser, type or ID. Gets one page; to see more, run it again skipping the ones you have.
Inputs
- Advertisers
advertiser_idslist - Only these advertisers. Leave empty for every advertiser.
- Segment types
segment_typeslist - Only segments of these types. Leave empty for all.One or more of:
ContactList(Contact list),Retargeting,Lookalike,Prospecting,InMarket(In-market),Location,Behavioral(Behavioral (made by Criteo)). - Segment IDs
segment_idslist - Only these segments, by ID.
- Page size
limitnumber - How many to return, 1 to 100. Criteo's default is 50.From 1 to 100.
- Skip
offsetnumber - How many to skip, to read the next page (for example 50).At least 0.
Outputs
countnumber- How many came back
offsetnumber- How many were skipped
segmentslist- The segments
totalnumber- How many match in all
Example output
{
"count": 1,
"offset": 0,
"segments": [
{
"advertiserId": "4949",
"contactList": {
"isReadOnly": false
},
"createdAt": "2026-05-09T16:30:50.4633333",
"description": "Contact list description",
"id": "1001",
"name": "My contact list segment",
"type": "ContactList",
"updatedAt": null
}
],
"total": 1
}Search audiences
List audiences with the ad sets that target them, by advertiser, audience, ad set or segment. Gets one page; to see more, run it again skipping the ones you have.
Inputs
- Advertisers
advertiser_idslist - Only these advertisers. Leave empty for every advertiser.
- Audiences
audience_idslist - Only these audiences. Leave empty for all.
- Ad sets
ad_set_idslist - Only these ad sets. Leave empty for every ad set.
- Segment IDs
segment_idslist - Only audiences built from these segments, by ID.
- Page size
limitnumber - How many to return, 1 to 100. Criteo's default is 50.From 1 to 100.
- Skip
offsetnumber - How many to skip, to read the next page (for example 50).At least 0.
Outputs
audienceslist- The audiences
countnumber- How many came back
offsetnumber- How many were skipped
totalnumber- How many match in all
Example output
{
"audiences": [
{
"adSetIds": [
"49122"
],
"advertiserId": "4949",
"algebra": {
"and": [
{
"or": [
{
"audienceSegmentId": "42914"
},
{
"audienceSegmentId": "19234"
}
]
},
{
"not": {
"audienceSegmentId": "3482"
}
}
]
},
"createdAt": "2026-07-04T00:00:00Z",
"description": "An audience which targets people of interest",
"id": "1001",
"name": "My audience",
"updatedAt": null
}
],
"count": 1,
"offset": 0,
"total": 1
}Search campaigns
List campaigns with their goal and spend limit, for some advertisers or campaigns, or every one the app can reach.
Inputs
- Advertisers
advertiser_idslist - Only these advertisers. Leave empty for every advertiser.
- Campaigns
campaign_idslist - Only these campaigns. Leave empty for every campaign.
Outputs
campaignslist- The campaigns
countnumber- How many came back
Example output
{
"campaigns": [
{
"advertiserId": "12345",
"budgetAutomation": {
"automatedBudgetConfiguration": null,
"enabled": false
},
"goal": "retention",
"id": "99999",
"name": "My Campaign",
"scheduledSpendLimits": [],
"sellerId": null,
"spendLimit": {
"spendLimitAmount": {
"value": 123.45
},
"spendLimitRenewal": "daily",
"spendLimitType": "capped"
}
}
],
"count": 1
}Set campaign spend limit
Cap what a campaign may spend each day, each month or over its lifetime, or remove the cap. Returns the campaign as it now is.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its ID from an earlier step.
- Spend limit
spend_limit_typetextRequired - Capped at an amount, or no limit.One of:
capped,uncapped(No limit). - Spend limit amount
spend_limit_amountnumber - The most it may spend, in the advertiser's currency. Needed when capped.Only when Spend limit is Capped. At least 0.01.
- Renews
spend_limit_renewaltext - When the amount starts again. Needed when capped.Only when Spend limit is Capped. One of:
daily(Each day),monthly(Each month),lifetime(Over the campaign's lifetime).
Outputs
campaignobject- The campaign
spend_limit_amountnumber- The spend limit in the advertiser's currency, empty if none
spend_limit_renewaltext- daily, monthly or lifetime; undefined if no limit
spend_limit_typetext- capped or uncapped
warningslist- Criteo's warnings about the change, if any
Example output
{
"campaign": {
"advertiserId": "12345",
"budgetAutomation": {
"automatedBudgetConfiguration": null,
"enabled": false
},
"goal": "retention",
"id": "99999",
"name": "My Campaign",
"scheduledSpendLimits": [],
"sellerId": null,
"spendLimit": {
"spendLimitAmount": {
"value": 123.45
},
"spendLimitRenewal": "daily",
"spendLimitType": "capped"
}
},
"spend_limit_amount": 123.45,
"spend_limit_renewal": "daily",
"spend_limit_type": "capped",
"warnings": []
}Start ad set
Turn an ad set on, so it delivers (and spends) within its schedule and budget. Nothing changes if it is already on.
Inputs
- Ad set
ad_set_idtextRequired - The ad set. Pick one, or give its ID from an earlier step.
Outputs
ad_set_idtext- The ad set
startedtrue/false- True once Criteo took it
warningslist- Criteo's warnings about the change, if any
Example output
{
"ad_set_id": "123467",
"started": true,
"warnings": []
}Stop ad set
Turn an ad set off, so it stops delivering and spending. Nothing changes if it is already off.
Inputs
- Ad set
ad_set_idtextRequired - The ad set. Pick one, or give its ID from an earlier step.
Outputs
ad_set_idtext- The ad set
stoppedtrue/false- True once Criteo took it
warningslist- Criteo's warnings about the change, if any
Example output
{
"ad_set_id": "123467",
"stopped": true,
"warnings": []
}Target ad set at audience
Make an ad set show its ads to an audience (built from segments with 'Create audience'), in place of the one it targets now.
Inputs
- Ad set
ad_set_idtextRequired - The ad set. Pick one, or give its ID from an earlier step.
- Audience
audience_idtextRequired - The audience. Pick one, or give its ID from an earlier step.
Outputs
ad_set_idtext- The ad set
audience_idtext- The audience it targets
Example output
{
"ad_set_id": "123467",
"audience_id": "9876"
}Update ad set
Change an ad set's name, bid, budget, start or end. Only the fields you fill in change. Returns the ad set as it now is.
Inputs
- Ad set
ad_set_idtextRequired - The ad set. Pick one, or give its ID from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Bid amount
bid_amountnumber - The new bid or target for the ad set's objective, in the advertiser's currency (up to 4 decimals).At least 0.0001.
- Budget
budget_strategytext - Capped at an amount, or no limit. Leave empty to keep it.One of:
capped,uncapped(No limit). - Budget amount
budget_amountnumber - The most it may spend each period, in the advertiser's currency.At least 0.01.
- Budget renews
budget_renewaltext - When the budget starts again.One of:
daily(Each day),weekly(Each week),monthly(Each month),lifetime(Over the ad set's lifetime). - Pacing
budget_delivery_smoothingtext - How the budget is spent across each period.One of:
standard(Spread evenly),accelerated(Spend as fast as it delivers well). - Start
start_datedate and time - When the ad set starts delivering.
- End
end_datedate and time - When the ad set stops delivering.
Outputs
activation_statustext- on or off: whether it is set to deliver
ad_setobject- The ad set
budget_amountnumber- The budget in the advertiser's currency, empty if no limit
delivery_statustext- Whether it delivers, such as live, paused, scheduled or ended
warningslist- Criteo's warnings about the change, if any
Example output
{
"activation_status": "on",
"ad_set": {
"adSetType": "standard",
"advertiserId": "12345",
"attributionConfiguration": {
"attributionMethod": "criteoAttribution",
"lookbackWindow": null
},
"bidding": {
"bidAmount": 0.9,
"costController": "maxCPC"
},
"budget": {
"budgetAmount": 123.45,
"budgetDeliverySmoothing": "standard",
"budgetDeliveryWeek": "mondayToSunday",
"budgetRenewal": "weekly",
"budgetStrategy": "capped",
"pacingBehavior": "targetFullBudget"
},
"campaignId": "99999",
"datasetId": "6789",
"destinationEnvironment": "web",
"id": "123467",
"mediaType": "display",
"name": "Campaign A",
"objective": "conversions",
"schedule": {
"activationStatus": "on",
"deliveryStatus": "live",
"endDate": {
"value": null
},
"startDate": {
"value": "2026-11-13T00:00:00Z"
}
},
"scheduledBudgets": [],
"targeting": {
"deliveryLimitations": {
"devices": [
"mobile",
"tablet",
"desktop"
]
},
"frequencyCapping": {
"frequency": "hourly",
"maximumImpressions": 3
},
"geoLocation": {
"countries": {
"operand": "in",
"values": [
"FR"
]
}
}
},
"videoChannel": null
},
"budget_amount": 123.45,
"delivery_status": "live",
"warnings": []
}Update audience segment
Rename an audience segment or change its description.
Inputs
- Segment
segment_idtextRequired - The audience segment's ID, from 'Search audience segments' or an earlier step. Contact lists are offered to pick from.
- Name
nametext - A new name. Leave empty to keep it.
- Description
descriptiontext - A new description. Leave empty to keep it.
Outputs
segmentobject- The segment
Example output
{
"segment": {
"advertiserId": "4949",
"contactList": {
"isReadOnly": false
},
"createdAt": "2026-05-09T16:30:50.4633333",
"description": "Contact list description",
"id": "1001",
"name": "My contact list segment (v2)",
"type": "ContactList",
"updatedAt": null
}
}