Update Existing Campaign

put

https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/campaigns

This API allows you to modify an existing campaign's details and manage its associated items. You must provide the campaign's unique ID along with the necessary changes in the request. The specified updates will be applied while preserving the campaign's unique identifier.

Body Params

Details about the campaign

name

string

The name of the campaign.

status

string

enum

Specified status of campaign.

Note: proposal and scheduled status are primarily relevant for SBA campaigns.

Allowed:

startDate

date

The date to start campaign.

endDate

date

The date when campaign ends.

budgetType

string

enum

The type of budget allocation you want to choose for your campaign.

Allowed:

totalBudget

double

Total budget of campaign.

dailyBudget

double

Daily budget of campaign.

Note: Daily budget cannot exceed your total budget amount. There is no limit on the amount of daily budget that can carry forward to the next day.

rollover

boolean

The indicator to suggest if the unspent daily budget from the previous day should be carried forward to next day’s daily budget.

campaignId

int32

required

ID of the campaign, required only if updating existing campaign.

campaignOptions

array of strings

List of campaign setting options while creating a campaign.
Campaign setting options:

Brand Term Targeting (BTT)
Complementary Product Targeting (CPT)

Note:
- BTT and CPT are only applicable to Sponsored Search automatic campaigns.
- All net new automatic campaigns will be opted in to Brand Term Targeting by default.
- Existing campaigns are opted out of BTT and CPT by default.

campaignOptions

Allowed:

biddingStrategy

object

A json object to store the bidding strategy.
Note: If you don’t pass biddingStrategy in the request, the default strategy will be FIXED.

Headers

WM_SEC.AUTH_SIGNATURE

string

required

Auth signature as an API key.

WM_CONSUMER.ID

string

required

We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.

WM_SEC.KEY_VERSION

integer

required

We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.

WM_CONSUMER.intimestamp

integer

required

Timestamp for which the auth signature is generated. Use Unix epoch format.

Authorization

string

required

The token will provide you the access to the API. It is same for all advertisers you access through the API.

Response

200successful operation