curl --request POST \
--url https://api.topsort.com/public/v1/campaign-service/campaigns \
--header 'Content-Type: application/json' \
--data '{
"adFormat": "listing",
"bids": [
{
"amount": 1,
"formatProperties": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"content": {},
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"size": 123,
"url": "<string>"
}
],
"deviceType": "desktop",
"slotId": "<string>"
},
"location": "Santiago",
"target": {
"id": "p_8983",
"type": "product"
},
"trigger": {
"type": "keyword",
"value": {
"matchType": "exact",
"words": [
"<string>"
]
}
},
"triggers": []
}
],
"budget": {
"amount": 1000,
"type": "daily"
},
"campaignType": "manual",
"chargeType": "CPM",
"endDate": "2023-11-07T05:31:56Z",
"externalCampaignId": "<string>",
"isActive": true,
"isAutoTrigger": false,
"name": "Bola-Bola Ad campaign",
"productIds": [
"<string>"
],
"promotionType": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"content": {},
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"size": 123,
"url": "<string>"
}
],
"deviceType": "desktop",
"slotId": "<string>"
},
"startDate": "2023-11-07T05:31:56Z",
"status": "approved",
"targetRoas": 10.25,
"walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
"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,
"isAutoTrigger": true,
"isSmart": true,
"marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Bola-Bola Ad campaign",
"promotionType": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"content": {},
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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"
}
Endpoint to create a campaign with its respective budget and bids.
It is expected to use at all types of campaign creations.
curl --request POST \
--url https://api.topsort.com/public/v1/campaign-service/campaigns \
--header 'Content-Type: application/json' \
--data '{
"adFormat": "listing",
"bids": [
{
"amount": 1,
"formatProperties": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"content": {},
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"size": 123,
"url": "<string>"
}
],
"deviceType": "desktop",
"slotId": "<string>"
},
"location": "Santiago",
"target": {
"id": "p_8983",
"type": "product"
},
"trigger": {
"type": "keyword",
"value": {
"matchType": "exact",
"words": [
"<string>"
]
}
},
"triggers": []
}
],
"budget": {
"amount": 1000,
"type": "daily"
},
"campaignType": "manual",
"chargeType": "CPM",
"endDate": "2023-11-07T05:31:56Z",
"externalCampaignId": "<string>",
"isActive": true,
"isAutoTrigger": false,
"name": "Bola-Bola Ad campaign",
"productIds": [
"<string>"
],
"promotionType": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"content": {},
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"size": 123,
"url": "<string>"
}
],
"deviceType": "desktop",
"slotId": "<string>"
},
"startDate": "2023-11-07T05:31:56Z",
"status": "approved",
"targetRoas": 10.25,
"walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
"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,
"isAutoTrigger": true,
"isSmart": true,
"marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Bola-Bola Ad campaign",
"promotionType": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"content": {},
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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"
}
The ID of the vendor.
1
The request body of campaign creation.
Successful Response
The campaign model.