PATCH
/
public
/
v1
/
campaign-service
/
campaigns
/
{campaign-id}

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
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

The campaign model.

adFormat
enum<string>
required

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

Available options:
listing,
banner
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 or by per mille impressions

Available options:
CPM,
CPC
createdAt
string
required

When was this campaign created.

endDate
string
required

The end date of the campaign.

externalVendorId
string
requireddeprecated

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

Delete Campaign By IdGet Campaign Bids