API Reference
Actions Reference
- POSTCreate Campaign
- POSTUpdate Campaign
- POSTGet Campaign By ID
- POSTGet Campaigns
- POSTCreate Ad Set
- POSTUpdate Ad Set
- POSTGet Ad Set By ID
- POSTGet Ad Sets
- POSTCreate Ad
- POSTUpdate Ad
- POSTGet Ad By ID
- POSTBuild Ad Creative Object
- POSTCreate Ad Creative
- POSTCreate Lead Gen Form
- POSTSend Purchase Event
- POSTSend Lead Event
- POSTSend Funnel Event
- POST
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#FACEBOOK_ADS_UPDATE_AD_SET' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "FACEBOOK_ADS_UPDATE_AD_SET",
"parameters": {
"adSetId": "<string>",
"campaignId": "<string>",
"name": "<string>",
"status": "PAUSED",
"optimizationGoal": "APP_INSTALLS",
"billingEvent": "APP_INSTALLS",
"bidAmount": "<string>",
"dailyBudget": "<string>",
"startTime": "<string>",
"targeting": {}
}
}
'Update Ad Set
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#FACEBOOK_ADS_UPDATE_AD_SET' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "FACEBOOK_ADS_UPDATE_AD_SET",
"parameters": {
"adSetId": "<string>",
"campaignId": "<string>",
"name": "<string>",
"status": "PAUSED",
"optimizationGoal": "APP_INSTALLS",
"billingEvent": "APP_INSTALLS",
"bidAmount": "<string>",
"dailyBudget": "<string>",
"startTime": "<string>",
"targeting": {}
}
}
'Authorizations
Your Paragon User Token (JWT), which you can generate using your project's signing keys.
Path Parameters
Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher.
Body
Show child attributes
Show child attributes
Ad Set ID : The ID of the ad set to update.
Specify the campaign ID to perform the operation on
Name : The name of the ad set.
Status : This value will default to Paused to prevent your test account from being billed while testing. Change this to Active for production uses.
PAUSED, ACTIVE Optimization Goal : Specify the optimization goal that this ad set will use.
APP_INSTALLS, AD_RECALL_LIFT, ENGAGED_USERS, EVENT_RESPONSES, IMPRESSIONS, LEAD_GENERATION, QUALITY_LEAD, LINK_CLICKS, OFFSITE_CONVERSIONS, PAGE_LIKES, POST_ENGAGEMENT, QUALITY_CALL, REACH, LANDING_PAGE_VIEWS, VISIT_INSTAGRAM_PROFILE, VALUE, VALUE_THROUGHPLAY, DERIVED_EVENTS, APP_INSTALLS_AND_OFFSITE_CONVERSIONS, CONVERSIONS Billing Event : Specify the billing event that this ad set will use.
APP_INSTALLS, CLICKS, IMPRESSIONS, LINK_CLICKS, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, VIDEO_VIEWS, VALUE_THROUGHPLAY Bid Amount : Set a maximum bid you want to pay for a result based on this ad set’s optimization goal. Value is in cents, for your account’s local currency.
Daily Budget : Set a daily budget for this ad set to use, in your account’s local currency.
Start Time : Specify when this ad set should start running. (example: "2021-01-01 12:00:00 AM")
Targeting : Provide a Targeting spec to define the audience for this ad set. (example: "{ "geo_locations": {"countries": ["US"]}, "interests": [{id: 6003139266461, 'name': 'Movies'}] }")
Response
Success
Was this page helpful?