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,
  "isVendorCampaign": false,
  "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

​
campaign-id
string
required

The ID of the campaign.

Body

application/json

Public Campaign Update Request Body

​
bannerAdRejectionReason
object
​
budget
object

The budget of the campaign.

​
campaignType
enum<string>

The bidding type of the campaign. Can only be updated to autobidding.

Available options:
autobidding
​
endDate
string

When should the campaign stop. Must be greater than start date.

​
isActive
boolean

Whether the campaign should be active/inactive.

​
isSmart
boolean

Whether the campaign is smart.

​
name
string

The name of the campaign.

Minimum length: 1
Example:

"Bola-Bola Ad campaign"

​
startDate
string

When should the campaign start. If the start date is in the past, it will be set to the current date.

​
status
enum<string>

The approval status of the campaign, if it's a banner campaign.

Available options:
approved,
pending,
rejected
​
statusUpdatedBy
string

The ID of the user who approved the banner campaign.

​
targetRoas
number

This is an indication of the vendor's advertising goals. However, a high ROAS (>12) is generally hard to achieve and depends on the metrics of the advertised products and the purchase attribution model used by the marketplace.

Required range: 0.5 <= x <= 20

Response

200
application/json
Successful Response

The campaign model.

​
adFormat
enum<string>
required

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

Available options:
listing,
banner,
exclusive_listing,
travel_listing,
flight_listing
​
bidCount
integer
required

The amount of active bids associated with this campaign.

​
campaignId
string
required

The ID of the campaign.

​
campaignType
enum<string>
required

The bidding method for the campaign.

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

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

Available options:
CPM,
CPC,
CPA
​
createdAt
string
required

When was this campaign created.

​
endDate
string
required

The end date of the campaign.

​
externalVendorId
string
required
deprecated

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

Minimum length: 1
​
isActive
boolean
required

Whether this campaign is active.

​
isSmart
boolean
required

Whether this campaign is "smart".

​
marketplaceId
string
required

The ID of the marketplace.

​
name
string
required

The name of the campaign.

Minimum length: 1
Example:

"Bola-Bola Ad campaign"

​
startDate
string
required

The starting date of the campaign.

​
status
enum<string>
required

Represents the review status of a banner campaign.

Available options:
approved,
pending,
rejected
​
vendorId
string
required

The ID of the vendor.

Minimum length: 1
​
walletId
string
required

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

​
budget
object

The budget assigned to the campaign.

​
campaignBehaviorData
string
deprecated

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

​
campaignBehaviorDataByDay
string
deprecated

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

​
exclusivityPrice
integer

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

​
externalCampaignId
string

The external ID of the campaign in the marketplace.

​
isVendorCampaign
boolean
default:false

Whether this is a promoted shop campaign.

​
promotionType
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.

​
statusUpdatedBy
string

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.

​
targetRoas
number

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