Stop a running campaign

put

https://marketplace.walmartapis.com/v3/advertising/sem/campaigns/{campaignId}/stop

This API allows you to stop an active campaign. Stopping a campaign does not delete it but prevents further actions. The campaign's unique ID must be included in the request.
Market availability: US only

Path Params

campaignId

string

required

Campaign ID of the campaign to be stopped.

Headers

WM_SEC.ACCESS_TOKEN

string

required

Access token obtained from the Token API. This is required for authenticating requests to Walmart Marketplace APIs.

WM_CONSUMER.CHANNEL.TYPE

string

A unique ID to identify the consumer request by channel. Use the Consumer Channel Type received during onboarding.

WM_QOS.CORRELATION_ID

string

required

A unique ID that identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID.

WM_SVC.NAME

string

required

Specifies the name of the Walmart service being called.

WM_GLOBAL_VERSION

string

enum

required

Defaults to 3.1

The version of the global API used.

Allowed:

WM_MARKET

string

enum

required

Defaults to us

Identifies the Walmart Marketplace region for the request.

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

204Successful Operation

400Bad Request

404Not Found

500Internal server error