Skip to content
Topsort Documentation
API

Update Campaign Bid By Id

PATCH
/v1/campaign-service/campaigns/{campaign-id}/bids/{bid-id}

Endpoint to update a bid.

Authentication

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization
required
string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

Path Parameters

object
campaign-id
required

The ID of the campaign.

string format: uuid

The ID of the campaign.

bid-id
required

The ID of the bid.

string format: uuid

The ID of the bid.

Request Body

The Bid update request body.

application/json
object
amount

Maximum amount of money willing to offer for a sponsored slot in minor units of currency according to ISO 4217.

integer format: int64
isActive

Whether to activate or deactivate the bid.

boolean

Responses

Successful Response

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

application/json
object
amount

Maximum amount of money willing to offer for a sponsored slot in minor units of currency according to ISO 4217.

integer format: int64
bidId
required

The ID of the bid

string format: uuid
bidsBehaviorData

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

string
campaignId
required

The ID of the campaign.

string format: uuid
formatProperties
object
adFormat
required
string
Allowed values: banner
bannerAssets
required

The assets for the banner campaign, if adFormat is banner.

Array<object>
>= 1 items

Represents the banner resource file, it’s location, mimetype, dimensions and size.

object
contentType
required

The mime type of the asset.

string
>= 1 characters
dimensions
required

The width and height of an asset.

object
height
required

The height of the image.

integer
width
required

The width of the image.

integer
size
required

The file size of the asset, in bytes.

integer
url
required

The url where the asset is located.

string format: uri
>= 1 characters <= 2083 characters
deviceType

The targeted device for this campaign, if adFormat is banner.

string
Allowed values: mobile desktop
slotId
required

The external slot id provided by the marketplace.

string
>= 1 characters /^[\w!\"#$%&'()*+,\-._/:;<>?@\[\]^\{\}~=\\]*$/
isActive
required

Whether the bid is active.

boolean
location

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.

string
>= 1 characters
state
required

The activity state of the bid.

string
Allowed values: active deactivated_manually inactive_entity deleted_entity legacy_inactive
target
required

The type of entity this bid will be targeting.

object
id
required

The unique ID of the entity.

string
>= 1 characters <= 256 characters
type
required
string
Allowed values: product brand vendor url
trigger
One of: discriminator: type

Collection of keywords that match to a product.

Ideal for search results pages.

object
type
required
string
Allowed values: keyword
value
required
object
matchType
required
string
Allowed values: exact
words
required

The list of keywords.

Array<string>
triggers
required

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

Array
One of: discriminator: type

Collection of keywords that match to a product.

Ideal for search results pages.

object
type
required
string
Allowed values: keyword
value
required
object
matchType
required
string
Allowed values: exact
words
required

The list of keywords.

Array<string>