Update Campaign By Id

Endpoint to update fields for a given campaign.

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.

Body

application/json

Public Campaign Update Request Body

name · string | null

The name of the campaign.

Minimum length: 1

Examples:

"Bola-Bola Ad campaign"

budget · object | null

The budget of the campaign. Campaign budget update request model.

Show child attributes

startDate · string<date-time> | null

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

endDate · string<date-time> | null

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

isActive · boolean | null

Whether the campaign should be active/inactive.

isSmart · boolean | null

Whether the campaign is smart.

campaignType · enum<string> | null

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

Available options:

autobidding

status · enum<string> | null

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

Available options:

approved,

pending,

rejected

statusUpdatedBy · string<uuid> | null

The ID of the user who approved the banner campaign.

isAutoTrigger · boolean | null

Whether the campaign is auto-triggered.

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

externalCampaignId · string | null

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

multiplierConfig · object | null

The multipliers of the campaign. The multiplier configuration for the campaign.

Show child attributes

targetingFilters · object | null

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

Show child attributes

exclusionFilters · object | null

The segments that the campaign will not target. The segments of users that the campaign will not target.

Show child attributes

chargeType · enum<string> | null

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

CPM: cost per mille impressions CPC: cost per click CPA: cost per action. CPA reflects the total cost to achieve a conversion.

Available options:

CPM,

CPC,

CPA

autobiddingObjective · enum<string> | null

The objective of the campaign, only for autobidding campaigns.

Available options:

impressions,

clicks,

conversions,

revenue

productIds · string[] | null

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.

Required array length: 1 - 200 elements

bannerAdRejectionReason · object | null

Show child attributes

Response

200

application/json

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 length: 1

Examples:

"Bola-Bola Ad campaign"

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. Campaign charge type.

CPM: cost per mille impressions CPC: cost per click CPA: cost per action. CPA reflects the total cost to achieve a conversion.

Available options:

CPM,

CPC,

CPA

externalVendorId · string · required · deprecated

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

Minimum 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 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 · object | null

The budget assigned to the campaign. A campaign budget.

Show child attributes

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 · object | null

The multiplier configuration for the campaign.

Show child attributes

targetingFilters · object | null

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

Show child attributes

exclusionFilters · object | null

The segments that the campaign will not target. The segments of users that the campaign will not target.

Show child attributes

promotionType · object | null · 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.

BannerAd

Show child attributes