Campaign API
Update Campaign By Id
Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Offsite Ads API
- POST[BETA] Create a new advertiser
- GET[BETA] Get advertiser details
- GET[BETA] List all audiences
- POST[BETA] Create a new audience
- POST[BETA] Upload users to an audience
- GET[BETA] List all campaigns
- POST[BETA] Create a new campaign
- GET[BETA] Get campaign details
- PATCH[BETA] Update campaign settings
- GET[BETA] Get campaign geotargeting settings
- GET[BETA] Get Job Status
- GET[BETA] Get campaign performance summary
- GET[BETA] Get daily campaign performance report
- GET[BETA] Get product-level campaign performance report
Assets API
Billing API
- GETGet Billing Contacts
- GETGet Billing Contact
- PUTUpsert Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Marketplace Credit Limit
- POSTSet Marketplace Credit Limit
- PUTUpsert Vendor Billing Contact
- GETGet Vendor Charges
- GETGet Vendor Account Activity
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- GETGet Vendor Credit History
- GETGet Vendor Credit Limit
- POSTSet Vendor Credit Limit
- DELDelete Vendor Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- POSTAdjust Wallet Balance
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- GETGet Campaign Restriction
- POSTCreate Campaign Restriction
- PATCHUpdate Campaign Restriction
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Restriction Types
- GETGet Restriction Type
- GETGet Sponsored Products
Catalog API
Invitation API
Reporting API
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
- GETGet Product Daily Report
- GETGet Interactions Dump Urls
- GETGet Scored Attribution Dump Urls
- GETGet Marketplace Interactions Report
- GETGet Marketplace Report
- GETGet Marketplace Campaigns Kpis
- GETGet Marketplace Daily Report
- GETGet Marketplace Vendors Kpis
- GETGet Vendor Report
- GETGet Vendor Daily Report
Segments Service
Toppie API
- GET[BETA] Get Agency Account Balance
- GET[BETA] Get Agency Account Top-ups
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Toppie Campaign Details
- DEL[BETA] Delete Toppie Campaign
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GET[BETA] List Account Products
- GET[BETA] Get Agency Account Report.
- GET[BETA] Account Activity Reports.
- GET[BETA] Get Campaigns Reporting.
- GET[BETA] Get Campaigns by IDs report.
- GET[BETA] Get Campaign Report.
- GET[BETA] Get Campaign Products Report.
Campaign API
Update Campaign By Id
Endpoint to update fields for a given campaign.
PATCH
/
public
/
v1
/
campaign-service
/
campaigns
/
{campaign-id}
curl --request PATCH \
--url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id} \
--header 'Content-Type: application/json' \
--data '{
"bannerAdRejectionReason": {
"declineReason": "<string>",
"reasonDetails": "<string>"
},
"budget": {
"amount": 1000,
"type": "daily"
},
"campaignType": "autobidding",
"endDate": "2023-11-07T05:31:56Z",
"isActive": true,
"isSmart": true,
"name": "Bola-Bola Ad campaign",
"startDate": "2023-11-07T05:31:56Z",
"status": "approved",
"statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetRoas": 10.25
}'
{
"adFormat": "listing",
"bidCount": 123,
"budget": {
"amount": 1000,
"amountCarryover": 123,
"amountRemaining": 123,
"amountUsed": 123,
"type": "daily"
},
"campaignBehaviorData": "<string>",
"campaignBehaviorDataByDay": "<string>",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaignType": "manual",
"chargeType": "CPM",
"createdAt": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"exclusivityPrice": 123,
"externalCampaignId": "<string>",
"externalVendorId": "<string>",
"isActive": true,
"isSmart": true,
"marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Bola-Bola Ad campaign",
"promotionType": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"size": 123,
"url": "<string>"
}
],
"deviceType": "desktop",
"slotId": "<string>"
},
"startDate": "2023-11-07T05:31:56Z",
"status": "approved",
"statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetRoas": 123,
"vendorId": "<string>",
"walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Path Parameters
The ID of the campaign.
Body
application/json
Public Campaign Update Request Body
Response
200
application/json
Successful Response
The campaign model.
curl --request PATCH \
--url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id} \
--header 'Content-Type: application/json' \
--data '{
"bannerAdRejectionReason": {
"declineReason": "<string>",
"reasonDetails": "<string>"
},
"budget": {
"amount": 1000,
"type": "daily"
},
"campaignType": "autobidding",
"endDate": "2023-11-07T05:31:56Z",
"isActive": true,
"isSmart": true,
"name": "Bola-Bola Ad campaign",
"startDate": "2023-11-07T05:31:56Z",
"status": "approved",
"statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetRoas": 10.25
}'
{
"adFormat": "listing",
"bidCount": 123,
"budget": {
"amount": 1000,
"amountCarryover": 123,
"amountRemaining": 123,
"amountUsed": 123,
"type": "daily"
},
"campaignBehaviorData": "<string>",
"campaignBehaviorDataByDay": "<string>",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaignType": "manual",
"chargeType": "CPM",
"createdAt": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"exclusivityPrice": 123,
"externalCampaignId": "<string>",
"externalVendorId": "<string>",
"isActive": true,
"isSmart": true,
"marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Bola-Bola Ad campaign",
"promotionType": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"size": 123,
"url": "<string>"
}
],
"deviceType": "desktop",
"slotId": "<string>"
},
"startDate": "2023-11-07T05:31:56Z",
"status": "approved",
"statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetRoas": 123,
"vendorId": "<string>",
"walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}