Skip to main content

Campaigns

A campaign has a business objective and organizes Ad Squads. You can define a goal and view stats for this campaign to see whether your goal has been reached. The reports and stats combines all the ad squads within this campaign.

Campaign Attributes

AttributeDescriptionRequiredPossible Values
ad_account_idAd Account IDR
daily_budget_microDaily Spend Cap (micro-currency)O
end_timeEnd timeO
nameCampaign nameRmax length: 375 characters
start_timeStart timeR
statusCampaign statusRACTIVE, PAUSED
lifetime_spend_cap_microLifetime spend cap for the campaign (microcurrency)O
measurement_specThe apps to be tracked for this campaignR - Required for tracking installs for campaigns containing these ad types: APP_INSTALL, DEEP_LINK, STORY (which swipes up to APP_INSTALL, DEEP_LINK) LENS_APP_INSTALL, LENS_DEEP_LINK{"ios_app_id":"1234", "android_app_url":"com.snapchat.android"}
objectiveObjective of the CampaignOBRAND_AWARENESS (default), APP_CONVERSION, APP_INSTALL, CATALOG_SALES, ENGAGEMENT, LEAD_GENERATION, VIDEO_VIEW, WEB_CONVERSION, PROMOTE_STORIES, PROMOTE_PLACES
objective_v2_propertiesSee table for Campaign Objective V2 propertiesOSee table for Campaign Objective V2 properties
buy_model**Buy ModelOAUCTION(default), RESERVED
regulations++Required for Campaigns that run Ads for Credit, Housing, Employment (CHE)O{ "restricted_delivery_signals": true }
regulations+-The candidate / ballot field is optional, but may be required in certain statesO{ "candidate_ballot_information":"Voting rights for dogs" }
delivery_statusDelivery statusRead-onlySee Delivery status
deletedIndicates whether the entity has been deleted or not, only shown when using the parameter read_deleted_entitiesRead-onlytrue

** Coming soon. See Reach And Frequency

++ The regulations attribute alongside restricted_delivery_signals is required for Campaigns running Ads promoting Housing, Credit, Employment (HCE), this attribute has to be activated at Ad Account level first or it cannot be used at Campaign level; https://businesshelp.snapchat.com/en-US/a/create-ad-account. Ad Squads created within a Campaign promoting HCE has a limited option of Optimization Goals.

+- The regulations attribute alongside the candidate_ballot_information field is optional, but may be required in certain states The paying_advertiser attribute has to be activated at Ad Account level first or the candidate/ballot field cannot be used at Campaign level; https://businesshelp.snapchat.com/en-US/a/create-ad-account

To enable app install and post-install attribution on ads, the measurement_spec field must be populated with the corresponding iOS and Android app IDs on campaign creation.

lifetime_spend_cap_micro can be increased and removed. Reducing the limit is allowed as long as the new limit is 1.1 times the amount already spent. daily_budget_micro set at the campaign level & the new lifetime_spend_cap_micro are evaluated independently. Delivery stops when either the Ad Account spend cap or the Campaign Lifetime spend cap is reached.

Campaign Objective V2 properties

The following attributes are used by the property objective_v2_properties

AttributeDescriptionRequiredPossible Values
objective_v2_typeThe Objective typeOAWARENESS_AND_ENGAGEMENT, SALES, TRAFFIC, APP_PROMOTION, LEADS
promotion_typeThe Promotion typeOPROMOTE_PLACES, PROMOTE_SHOWS, APP_INSTALL, APP_REENGAGEMENT

Campaign Objective V2

The new Campaign level attribute objective_v2_properties replaces the objective attribute, the objective attribute offered users a choice of 12 different Campaign objectives when setting up a Campaign, with the introduction of objective_v2_properties this has changed to 5 options.

The objective_v2_properties attribute is optional, just as the objective attribute was, and is used only for the business logic surfaced by Snap Ads Manager, determining the Optimization Goal options available to Ad Squads. If your application is currently making use of the objective attribute, you are expected to start using objective_v2_properties before 2025.

Along with the launch of objective_v2_properties we are also launching a new entity named Ad Squad Render UI Data ( ad_squad_ui_render_data ), this entity has a one-to-one relationship with the Ad Squad entity and is part of the business logic decision tree. The Ad Squad Render UI Data tells the business logic whether the Ad Squad contains ads for WEB, APP, or MIXED in the case of a combination of the two,

Timelines Objective V2

TimePhaseDescription
September - December 2024Roll-out of objective_v2_propertiesThe default state for Ads creation in Ads Manager will be the new Advanced creation flow that use objective_v2_properties.
We will continue to set both the objective and objective_v2_properties for Campaigns to ensure that Partner applications can still handle these Campaigns - see table Snap Ads Manager - objective to objective_v2

Applications that make use of the objective value are expected to make the transition from objective and fully adopt objective_v2_properties see table Business logic - objective to objective_v2 for guidance on the new Business logic.
Q4 - 2024Backfill of objective_v2_propertiesIn the final quarter of the year we will automatically populate the objective_v2_properties for campaigns that only contain the objective value.
After the backfill any application that still sets up Campaigns with the objective only will have an objective_v2_properties value inferred based on the objective value - see table API Campaign creation default behaviour in 2024 - Q4 .
2025Deprecation of the objective attributeAt some point in 2025 the Marketing API will reject Campaign creation requests that don’t contain objective_v2_properties

Business logic - objective to objective_v2

This table compares the business logic of the objective attribute to the new objective_v2_properties attribute, this allows 3rd party applicationss to fully or partly follow the same Business Logic that Snap Ads Manager offers.

The left side of the table presents Optimization Goals based on the old objective attribute, the right side of the table presents the Optimization Goals based on objective_v2_properties. The conversion_location column refers to the new entity ad_squad_ui_render_data and defines goals offered based on the intended location of conversion, Web, App or Lead form.

Note that validation given SKAd enablement, Dynamic Ads and HCE (Housing Credit Employment) still is applicable to the Optimization Goals available. Read about HCE and Optimization Goals

Previous logic - objective onlyNew logic - Campaign objective_v2_type - promotion_type - Ad Squad UI Render Data
objectiveoptimization goalsobjective_v2_typepromotion_typeconversion_locationoptimization goals
BRAND_AWARENESSIMPRESSIONS, SWIPES, STORY_OPENS, USESAWARENESS_AND_ENGAGEMENT--IMPRESSIONS, SWIPES, STORY_OPENS, USES, VIDEO_VIEWS, VIDEO_VIEWS_15_SEC
PROMOTE_STORIESIMPRESSIONSAWARENESS_AND_ENGAGEMENTPROMOTE_STORIES*-IMPRESSIONS
PROMOTE_PLACESSWIPESAWARENESS_AND_ENGAGEMENTPROMOTE_PLACES*-SWIPES
APP_CONVERSIONSWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN, LANDING_PAGE_VIEWAPP_PROMOTIONAPP_INSTALLAPPIMPRESSIONS, SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW
APP_CONVERSION with Dynamic AdsSWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPENAPP_PROMOTIONAPP_INSTALL with Dynamic AdsAPPIMPRESSIONS, SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW
APP_CONVERSION with SKAdNetwork enabledSWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CARTAPP_PROMOTIONAPP_INSTALL with SKAdNetwork enabledAPPIMPRESSIONS, SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART
APP_CONVERSION with Dynamic Ads and SKAdNetwork enabledSWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUPAPP_PROMOTIONAPP_INSTALL with Dynamic Ads and SKAdNetwork enabledAPPIMPRESSIONS, SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART
WEB_CONVERSIONSWIPES, STORY_OPENS, PIXEL_PAGE_VIEW, PIXEL_SIGNUP, PIXEL_ADD_TO_CART, PIXEL_PURCHASE, PIXEL_PURCHASE_VO, LANDING_PAGE_VIEWSALES-WEBSWIPES, STORY_OPENS, PIXEL_PURCHASE, PIXEL_SIGNUP, PIXEL_ADD_TO_CART, PIXEL_PAGE_VIEW, LANDING_PAGE_VIEW
LEAD_GENERATIONLEAD_FORM_SUBMISSIONS, SWIPES, STORY_OPENS, PIXEL_SIGN_UPLEADS-WEBSWIPES, STORY_OPENS, PIXEL_SIGN_UP, LANDING_PAGE_VIEW
LEAD_GENERATIONLEAD_FORM_SUBMISSIONS, SWIPES, STORY_OPENS, PIXEL_SIGN_UPLEADS-LEAD_FORMSWIPES, LEAD_FORM_SUBMISSIONS
--LEADS-CALL, TEXTIMPRESSIONS, SWIPES
APP_INSTALLSWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_AD_VIEWAPP_PROMOTIONAPP_INSTALL-SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW
APP_INSTALL with Dynamic AdsSWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CARTAPP_PROMOTIONAPP_INSTALL with Dynamic Ads-SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW
APP_INSTALL with SKAdNetwork enabledSWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CARTAPP_PROMOTIONAPP_INSTALL with SKAdNetwork enable-SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART
APP_INSTALL with Dynamic Ads and SKAdNetwork enabledSWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CARTAPP_PROMOTIONAPP_INSTALL with Dynamic Ads and SKAdNetwork enabled-SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART
APP_CONVERSIONSWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN LANDING_PAGE_VIEWAPP_PROMOTIONAPP_REENGAGEMENT-SWIPES, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN, LANDING_PAGE_VIEW
APP_CONVERSION with Dynamic AdsSWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CARTAPP_PROMOTIONAPP_REENGAGEMENT with Dynamic Ads-SWIPES, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN, LANDING_PAGE_VIEW
APP_CONVERSION with SKAdNetwork enabledSWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CARTAPP_PROMOTIONAPP_REENGAGEMENT with SKAdNetwork enabled-SWIPES, LANDING_PAGE_VIEW
APP_CONVERSION with Dynamic Ads and SKAdNetwork enabledSWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART-This combination is not available when using objective_v2_type
CATALOG_SALESSWIPES, STORY_OPENS, PIXEL_PURCHASE, PIXEL_ADD_TO_CART, PIXEL_SIGNUP, PIXEL_PAGE_VIEW, PIXEL_PURCHASE_VO, LANDING_PAGE_VIEWSALES-WEBSWIPES, STORY_OPENS, PIXEL_PURCHASE, PIXEL_SIGNUP, PIXEL_ADD_TO_CART, PIXEL_PAGE_VIEW, LANDING_PAGE_VIEW
CATALOG_SALESIMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_ADD_TO_CART, APP_SIGNUP, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPENSALES-APPIMPRESSIONS, SWIPES, APP_REENGAGE_PURCHASE APP_REENGAGE_OPEN,
CATALOG_SALES with SKAdNetwork enabledIMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_ADD_TO_CART, APP_SIGNUP, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPENSALES-APPSKAd Network opted-in IMPRESSIONS, SWIPES, STORY_OPENS
CATALOG_SALESSWIPES, STORY_OPENS, PIXEL_PURCHASE, PIXEL_ADD_TO_CART, PIXEL_SIGNUP, PIXEL_PAGE_VIEW, PIXEL_PURCHASE_VO, LANDING_PAGE_VIEWSALES-WEBSWIPES, STORY_OPENS, PIXEL_PURCHASE, PIXEL_SIGNUP, PIXEL_ADD_TO_CART, PIXEL_PAGE_VIEW, LANDING_PAGE_VIEW
VIDEO_VIEWIMPRESSIONS, VIDEO_VIEWS, VIDEO_VIEWS_15_SECAWARENESS_AND_ENGAGEMENT--IMPRESSIONS, SWIPES, STORY_OPENS, USES, VIDEO_VIEWS, VIDEO_VIEWS_15_SEC
ENGAGEMENTSWIPES, USES, STORY_OPENS, PIXEL_PURCHASEAWARENESS_AND_ENGAGEMENT--IMPRESSIONS, SWIPES, STORY_OPENS, USES, VIDEO_VIEWS, VIDEO_VIEWS_15_SEC
WEB_VIEWSWIPES, PIXEL_PAGE_VIEW, LANDING_PAGE_VIEWTRAFFIC-WEBSWIPES, PIXEL_PAGE_VIEW, LANDING_PAGE_VIEW
APP_REENGAGEMENTSWIPES, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN, LANDING_PAGE_VIEWTRAFFIC-APPSWIPES, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN, LANDING_PAGE_VIEW
WEB_VIEWIMPRESSIONS, SWIPESTRAFFIC-PUBLIC_PROFILE, CALL, TEXTIMPRESSIONS, SWIPES

*The objectives PROMOTE_STORIES and PROMOTE_PLACES are generally not available to create via the API.

Snap Ads Manager - objective to objective_v2

This table explains how Snap Ads Manager is currently setting the Campaign objective valued based on the new Campaign objective_v2_properties logic.

objective_v2_typepromotion_typecatalog_id presentconversion_locationobjective
AWARENESS_AND_ENGAGEMENTPROMOTE_STORIES*-PROMOTE_STORIES*
AWARENESS_AND_ENGAGEMENTPROMOTE_PLACES*-PROMOTE_PLACES*
AWARENESS_AND_ENGAGEMENT--BRAND_AWARENESS
TRAFFIC--WEBWEB_VIEW
TRAFFIC--APPAPP_REENGAGEMENT
TRAFFIC--WEBWEB_VIEW
LEADS--LEAD GENERATION
APP_PROMOTIONAPP_INSTALLNOAPP_INSTALL
APP_PROMOTIONAPP_INSTALLYESCATALOG_SALES
APP_PROMOTIONAPP_REENGAGEMENTNOAPP_CONVERSION
APP_PROMOTIONAPP_REENGAGEMENTYESCATALOG_SALES
SALES-NOWEBWEB_CONVERSION
SALES-NOAPPAPP_CONVERSION
SALES-NOWEBWEB_CONVERSION
SALES-YESWEBCATALOG_SALES
SALES-YESAPPCATALOG_SALES

objective_v2 - API Campaign creation default behaviour in 2024 - Q4

This table explains how default values for objective_v2_properties will be set for 3rd party applications in 2024 Q4, this only concerns applications that are only setting the objective attribute.

objectivecatalog_id presentobjective_v2_typepromotion_type
BRAND_AWARENESS-AWARENESS_AND_ENGAGEMENT-
PROMOTE_STORIES-AWARENESS_AND_ENGAGEMENTPROMOTE_SHOWS
PROMOTE_PLACES-AWARENESS_AND_ENGAGEMENTPROMOTE_PLACES
LEAD_GENERATIONLEADS
APP_INSTALL-APP_PROMOTIONAPP_INSTALL
APP_CONVERSION-APP_PROMOTIONAPP_REENGAGEMENT
CATALOG_SALESYESAPP_PROMOTIONAPP_INSTALL
CATALOG_SALESYESAPP_PROMOTIONAPP_REENGAGEMENT
WEB_CONVERSION-SALES-
APP_CONVERSION-SALES-
CATALOG_SALESYESSALES-
VIDEO_VIEW-AWARENESS_AND_ENGAGEMENT-
ENGAGEMENT-AWARENESS_AND_ENGAGEMENT-
WEB_VIEW-TRAFFIC-
APP_REENGAGEMENT-TRAFFIC-

Create a Campaign

curl -X POST \
-H "Authorization: Bearer meowmeowmeow" \
-H "Content-Type: application/json" \
-d '{"campaigns": [{"name": "Cool Campaign", "ad_account_id": "3b0fbace-04b4-4f04-a425-33b5e0af1d0d", "status": "PAUSED", "start_time": "2016-08-11T22:03:58.869Z"}]}' \
"https://adsapi.snapchat.com/v1/adaccounts/{ad_acount_id}/campaigns"

The above command returns JSON structured like this:

{
"request_status": "success",
"request_id": "57b002ad00ff07e1f50fd2267f0001737e616473617069736300016275696c642d35396264653638322d312d31312d370001010d",
"campaigns": [
{
"sub_request_status": "success",
"campaign": {
"id": "92e1c28a-a331-45b4-8c26-fd3e0eea8c39",
"updated_at": "2016-08-14T05:33:33.876Z",
"created_at": "2016-08-14T05:33:33.876Z",
"name": "Cool Campaign",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"status": "PAUSED",
"start_time": "2016-08-11T22:03:58.869Z"
}
}
]
}

This endpoint will create a campaign within a specified ad account.

HTTP Request

POST https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/campaigns

Parameters

ParameterDefaultDescription
ad_account_idAd Account ID

Update a Campaign

curl -X PUT \
-H "Authorization: Bearer meowmeowmeow" \
-H "Content-Type: application/json" \
-d '{"campaigns": [{"name": "Cool Campaign", "ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74", "status": "PAUSED", "start_time": "2016-08-11T22:03:58.869Z", "end_time": "2016-08-21T22:03:58.869-0700", "id": "92e1c28a-a331-45b4-8c26-fd3e0eea8c39"}]}'
https://adsapi.snapchat.com/v1/adaccounts/8adc3db7-8148-4fbf-999c-8d2266369d74/campaigns

The above command returns JSON structured like this:

{
"request_status": "success",
"request_id": "57b0032700ff07e0cfdaa5e1a40001737e616473617069736300016275696c642d35396264653638322d312d31312d3700010105",
"campaigns": [
{
"sub_request_status": "success",
"campaign": {
"id": "92e1c28a-a331-45b4-8c26-fd3e0eea8c39",
"updated_at": "2016-08-14T05:35:35.943Z",
"created_at": "2016-08-14T05:33:33.876Z",
"name": "Cool Campaign",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"status": "PAUSED",
"start_time": "2016-08-11T22:03:58.869Z",
"end_time": "2016-08-22T05:03:58.869Z"
}
}
]
}

This endpoint will update a specified campaign.

Attributes that can be updated

AttributeDescriptionRequiredPossible Values
end_timeEnd timeO
nameCampaign nameR
daily_budget_microDaily Spend Cap (micro-currency)O
lifetime_spend_cap_microLifetime spend cap for the campaign (micro-currency)O
start_timeStart timeO
statusCampaign statusRACTIVE, PAUSED

HTTP Request

PUT https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/campaigns

Parameters

ParameterDefaultDescription
ad_account_idAd Account ID

Get All Campaigns

curl "https://adsapi.snapchat.com/v1/adaccounts/8adc3db7-8148-4fbf-999c-8d2266369d74/campaigns" \
-H "Authorization: Bearer meowmeowmeow"

The above command returns JSON structured like this:

{
"request_status": "success",
"request_id": "57b003c700ff0f2e66c37f96c20001737e616473617069736300016275696c642d35396264653638322d312d31312d3700010103",
"campaigns": [
{
"sub_request_status": "success",
"campaign": {
"id": "06302efa-4c0f-4e36-b880-a395a36cef64",
"updated_at": "2016-08-12T20:28:58.738Z",
"created_at": "2016-08-12T20:28:58.738Z",
"name": "Campaign One",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"daily_budget_micro": 200000000,
"status": "ACTIVE",
"start_time": "2016-08-10T17:12:49.707Z",
"end_time": "2016-08-13T17:12:49.707Z"
}
},
{
"sub_request_status": "success",
"campaign": {
"id": "0fc8e179-6f3b-46e7-be8e-ca53fd404ece",
"updated_at": "2016-08-12T21:06:18.343Z",
"created_at": "2016-08-12T21:06:18.343Z",
"name": "Campaign Deux",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"daily_budget_micro": 500000000,
"status": "ACTIVE",
"start_time": "2016-08-10T17:12:49.707Z",
"end_time": "2016-08-13T17:12:49.707Z"
}
},

[[[ snip ]]]

{
"sub_request_status": "success",
"campaign": {
"id": "92e1c28a-a331-45b4-8c26-fd3e0eea8c39",
"updated_at": "2016-08-14T05:36:46.441Z",
"created_at": "2016-08-14T05:33:33.876Z",
"name": "Cool Campaign",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"status": "PAUSED",
"start_time": "2016-08-11T22:03:58.869Z",
"end_time": "2016-08-22T05:03:58.869Z"
}
},
{
"sub_request_status": "success",
"campaign": {
"id": "fedf8e04-0176-4ce3-a1ca-148204aee62c",
"updated_at": "2016-08-12T02:18:33.412Z",
"created_at": "2016-08-12T02:18:33.412Z",
"name": "Crazy Campaign",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"start_time": "2016-08-11T22:03:58.869Z",
"status": "PAUSED"
}
}
]
}

This endpoint retrieves all campaigns within a specified ad account.

HTTP Request

GET https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/campaigns

Parameters

ParameterDefaultDescription
ad_account_idAd Account ID
read_deleted_entitiestrueoptional parameter, this param will return the deleted attribute on deleted Campaign entities

Get a Specific Campaign

curl "https://adsapi.snapchat.com/v1/campaigns/92e1c28a-a331-45b4-8c26-fd3e0eea8c39" \
-H "Authorization: Bearer meowmeowmeow"

The above command returns JSON structured like this:

{
"request_status": "success",
"request_id": "57b0049c00ff0e8cb21af5199c0001737e616473617069736300016275696c642d35396264653638322d312d31312d3700010107",
"campaigns": [
{
"sub_request_status": "success",
"campaign": {
"id": "92e1c28a-a331-45b4-8c26-fd3e0eea8c39",
"updated_at": "2016-08-14T05:36:46.441Z",
"created_at": "2016-08-14T05:33:33.876Z",
"name": "Cool Campaign",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"status": "PAUSED",
"start_time": "2016-08-11T22:03:58.869Z",
"end_time": "2016-08-22T05:03:58.869Z"
}
}
]
}

This endpoint retrieves a specific campaign.

HTTP Request

GET https://adsapi.snapchat.com/v1/campaigns/{campaign_id}

URL Parameters

ParameterDefaultDescription
campaign_idCampaign ID
read_deleted_entitiestrueoptional parameter, this param will return the deleted attribute on deleted Campaign entities

Delete a Specific Campaign

curl -X DELETE "https://adsapi.snapchat.com/v1/campaigns/92e1c28a-a331-45b4-8c26-fd3e0eea8c39" \
-H "Authorization: Bearer meowmeowmeow"

The above command returns JSON structured like this:

{
"request_status": "success",
"request_id": "57b004dc00ff0e29c26b5d51840001737e616473617069736300016275696c642d35396264653638322d312d31312d3700010106",
"campaigns": []
}

This endpoint deletes a specific campaign.

HTTP Request

DELETE https://adsapi.snapchat.com/v1/campaigns/<ID>

URL Parameters

ParameterDescription
IDThe ID of the campaign to delete
Was this page helpful?
Yes
No

AI-Powered Search