Skip to main content
POST
/
public
/
v1
/
campaign-service
/
campaigns
Create Campaign
curl --request POST \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "bids": [
    {
      "target": {
        "id": "<string>",
        "type": "product"
      },
      "amount": "<unknown>",
      "location": "Santiago",
      "trigger": {
        "type": "<string>",
        "value": {
          "words": [
            "<string>"
          ],
          "matchType": "exact"
        }
      },
      "triggers": [],
      "formatProperties": {
        "bannerAssets": [
          {
            "dimensions": {
              "width": 123,
              "height": 123
            },
            "url": "<string>",
            "contentType": "image/png",
            "size": 123,
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "content": {},
            "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "slotId": "<string>",
        "adFormat": "<string>",
        "deviceType": "desktop"
      }
    }
  ],
  "campaignType": "manual",
  "isActive": true,
  "externalCampaignId": "<string>",
  "isAutoTrigger": false,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "targetRoas": 10.25,
  "promotionType": {
    "bannerAssets": [
      {
        "dimensions": {
          "width": 123,
          "height": 123
        },
        "url": "<string>",
        "contentType": "image/png",
        "size": 123,
        "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
        "content": {},
        "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "slotId": "<string>",
    "adFormat": "<string>",
    "deviceType": "desktop"
  },
  "status": "approved",
  "adFormat": "listing",
  "budget": {
    "amount": 123,
    "type": "daily"
  },
  "chargeType": "CPM",
  "productIds": [
    "<string>"
  ],
  "multiplierConfig": {
    "isActive": true,
    "multipliers": [
      {
        "type": "<string>",
        "segmentId": 123,
        "multiplier": 2
      }
    ]
  },
  "targetingFilters": {
    "isActive": true,
    "targetingFilters": [
      {
        "type": "<string>",
        "segmentId": 123
      }
    ]
  },
  "exclusionFilters": {
    "isActive": true,
    "exclusionFilters": [
      {
        "type": "<string>",
        "segmentId": 123
      }
    ]
  },
  "autobiddingObjective": "impressions",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "isSmart": true,
  "campaignType": "manual",
  "status": "approved",
  "createdAt": "2023-11-07T05:31:56Z",
  "chargeType": "CPM",
  "externalVendorId": "<string>",
  "adFormat": "listing",
  "isAutoTrigger": true,
  "vendorId": "<string>",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bidCount": 123,
  "budget": {
    "amount": 123,
    "amountRemaining": 123,
    "amountCarryover": 123,
    "amountUsed": 123,
    "type": "daily"
  },
  "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignBehaviorData": "<string>",
  "campaignBehaviorDataByDay": "<string>",
  "exclusivityPrice": 123,
  "targetRoas": 123,
  "externalCampaignId": "<string>",
  "autobiddingObjective": "impressions",
  "multiplierConfig": {
    "isActive": true,
    "multipliers": [
      {
        "type": "<string>",
        "segmentId": 123,
        "multiplier": 2
      }
    ]
  },
  "targetingFilters": {
    "isActive": true,
    "targetingFilters": [
      {
        "type": "<string>",
        "segmentId": 123
      }
    ]
  },
  "exclusionFilters": {
    "isActive": true,
    "exclusionFilters": [
      {
        "type": "<string>",
        "segmentId": 123
      }
    ]
  },
  "promotionType": {
    "bannerAssets": [
      {
        "dimensions": {
          "width": 123,
          "height": 123
        },
        "url": "<string>",
        "contentType": "image/png",
        "size": 123,
        "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
        "content": {},
        "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "slotId": "<string>",
    "adFormat": "<string>",
    "deviceType": "desktop"
  }
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

​
vendor_id
string
required

The ID of the vendor.

Minimum string length: 1

Body

application/json

The request body of campaign creation.

​
name
string
required

The name of the campaign.

Minimum string length: 1
​
bids
BidCreate · object[]
required

An array of bids for this campaign.

Minimum array length: 1
​
campaignType
enum<string>
required

The bidding method for the campaign.

Available options:
manual,
autobidding,
exclusive
​
isActive
boolean
default:true

Whether the campaign should be activated upon creation.The campaign will start when this is set and the start_date has passed.

​
externalCampaignId
string | null

The external ID of the campaign in the marketplace. Must be unique per marketplace and format combination.

​
isAutoTrigger
boolean
default:false

Whether the campaign is auto-triggered.

​
startDate
string<date-time>

Date when to start the campaign, specified in RFC 3339, if not set that campaign will start immediately after the campaign creation. Must include the Timezone definition.If the start date is in the past, it will be set to the current date.

​
endDate
string<date-time>

Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.

​
targetRoas
number | null

Indicates the vendor's goal. For banners, use autobiddingObjective instead. ROAS >12 is rare and depends on product metrics and attribution model.

Required range: 0.5 <= x <= 20
​
promotionType
BannerAd · object
deprecated

Deprecated. Use adFormat field instead and format properties inside bids. The promotion type and attributes. Ad format must set to 'banner' for exclusive campaigns.

​
status
enum<string>
default:approved

For a banner campaign, its initial review status.

Available options:
approved,
pending,
rejected
​
adFormat
enum<string> | null

The ad format of the campaign. Can be listing or banner.

Available options:
listing,
banner
Example:

"listing"

​
budget
BudgetCreate · object

The assigned budget for the campaign.

​
chargeType
enum<string> | null

How campaigns are going to be charged, by click, by per mille impressions, or by action. ListingAd campaigns are charged per click by default. BannerAd campaigns are charged per mille impressions by default.CPA is only allowed for listing campaigns. For CPA campaigns, the budget type must be total.

Available options:
CPM,
CPC,
CPA
​
productIds
string[]

The product IDs to be used in the banner campaign. This is only allowed for banner campaigns. When provided, the assets will be associated to the given product IDs.

Maximum array length: 200
​
multiplierConfig
CampaignMultiplierConfig · object

The multipliers of the campaign.

​
targetingFilters
CampaignTargetingFilters · object

The segments that the campaign will participate for (and will not for other segments not here).

​
exclusionFilters
CampaignExclusionFilters · object

The segments that the campaign will not target.

​
autobiddingObjective
enum<string> | null

The objective of the campaign, only for autobidding campaigns.

Available options:
impressions,
clicks,
conversions,
revenue
​
walletId
string<uuid> | null

The uuid of the wallet to be used with this campaign.

Response

Successful Response

The campaign model.

​
campaignId
string<uuid>
required

The ID of the campaign.

​
marketplaceId
string<uuid>
required

The ID of the marketplace.

​
name
string
required

The name of the campaign.

Minimum string length: 1
​
startDate
string<date-time>
required

The starting date of the campaign.

​
endDate
string<date-time>
required

The end date of the campaign.

​
isActive
boolean
required

Whether this campaign is active.

​
isSmart
boolean
required

Whether this campaign is "smart".

​
campaignType
enum<string>
required

The bidding method for the campaign.

Available options:
manual,
autobidding,
exclusive
​
status
enum<string>
required

Represents the review status of a banner campaign.

Available options:
approved,
pending,
rejected
​
createdAt
string<date-time>
required

When was this campaign created.

​
chargeType
required

How campaigns are going to be charged, by click, by per mille impressions, or by action.

Available options:
CPM,
CPC,
CPA
​
externalVendorId
string
required
deprecated

The ID of the vendor. Deprecated. Use vendor_id instead.

Minimum string length: 1
​
adFormat
enum<string>
required

The ad format of the campaign. Can be listing or banner.

Available options:
listing,
banner,
sponsored_brand,
exclusive_listing,
exclusive_banner,
travel_listing,
flight_listing
​
isAutoTrigger
boolean
required

Whether the campaign is auto-triggered.

​
vendorId
string
required

The ID of the vendor.

Minimum string length: 1
​
walletId
string<uuid>
required

The uuid of the wallet to be used with this campaign.

​
bidCount
integer
required

The amount of active bids associated with this campaign.

​
budget
Budget · object

The budget assigned to the campaign.

​
statusUpdatedBy
string<uuid> | null

The ID of the user who reviewed the campaign. If it's null and the status is not "pending" then it means this campaign has autoapproval status.

​
campaignBehaviorData
string | null
deprecated

Deprecated. This field is always null. For behavioral data use reporting service.

​
campaignBehaviorDataByDay
string | null
deprecated

Deprecated. This field is always null. For behavioral data use reporting service.

​
exclusivityPrice
integer | null

Daily price for an exclusive campaign, can only be set if a campaign is exclusive

​
targetRoas
number | null

The target return on ad spend (ROAS) for this campaign. This is only applicable for autobidding listing campaigns.

​
externalCampaignId
string | null

The external ID of the campaign in the marketplace. Must be unique per marketplace and format combination.

​
autobiddingObjective
enum<string> | null

The autobidding objective for the campaign.

Available options:
impressions,
clicks,
conversions,
revenue
​
multiplierConfig
CampaignMultiplierConfig · object

The multiplier configuration for the campaign.

​
targetingFilters
CampaignTargetingFilters · object

The segments that the campaign will participate for (and will not for other segments not here).

​
exclusionFilters
CampaignExclusionFilters · object

The segments that the campaign will not target.

​
promotionType
BannerAd · object
deprecated

Deprecated. Use adFormat field instead and format properties inside bids. The promotion type and attributes. Ad format must set to 'banner' for exclusive campaigns.