Skip to main content
PATCH
/
public
/
v1
/
campaign-service
/
campaigns
/
{campaign-id}
/
bids
/
{bid-id}
Update Campaign Bid By Id
curl --request PATCH \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/bids/{bid-id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<unknown>",
  "isActive": true
}
'
{
  "bidId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target": {
    "id": "<string>",
    "type": "product"
  },
  "isActive": true,
  "triggers": [
    {
      "type": "<string>",
      "value": {
        "words": [
          "<string>"
        ],
        "matchType": "exact"
      }
    }
  ],
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "active",
  "amount": "<unknown>",
  "trigger": {
    "type": "<string>",
    "value": {
      "words": [
        "<string>"
      ],
      "matchType": "exact"
    }
  },
  "location": "Santiago",
  "bidsBehaviorData": "<string>",
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Path Parameters

​
campaign-id
string<uuid>
required

The ID of the campaign.

​
bid-id
string<uuid>
required

The ID of the bid.

Body

application/json

The Bid update request body.

​
amount
any
​
isActive
boolean | null

Whether to activate or deactivate the bid.

Response

Successful Response

Represents an auction bid for a specific entity and a specific maximum amount.

​
bidId
string<uuid>
required

The ID of the bid

​
target
Entity · object
required

The type of entity this bid will be targeting.

​
isActive
boolean
required

Whether the bid is active.

​
triggers
(KeywordTrigger · object | CategoryTrigger · object | CategoriesTrigger · object | ProductTrigger · object | NoContextTrigger · object | KeywordsFromCampaignProductsTrigger · object | CategoriesFromCampaignProductsTrigger · object)[]
required

A list of objects that trigger the appearance of this bid on an auction.

When should this bid participate in an auction.

​
campaignId
string<uuid>
required

The ID of the campaign.

​
state
enum<string>
required

The activity state of the bid.

Available options:
active,
deactivated_manually,
inactive_entity,
deleted_entity,
legacy_inactive
​
amount
any
​
trigger
KeywordTrigger · object
deprecated

An object that triggers the appearance of this bid on an auction.

​
location
string | null

By using this option you will be able to target this campaign to a specific group.You must define the same location as a parameter on the auction request. Products on a specific campaign will have specific conversion rates, considering the context of location, so it will not interfere with the conversion rates for the same product in other campaigns.

Minimum string length: 1
Example:

"Santiago"

​
bidsBehaviorData
string | null
deprecated

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

​
formatProperties
BannerAd · object