Update Subscription

patch

https://marketplace.walmartapis.com/v3/webhooks/subscriptions/{subscriptionId}

Update the details of a subscription. You can update the event version, destination URL, headers, and authentication details. You can also enable or disable the subscription by changing the status to ACTIVE or INACTIVE.

Market availability: Global

Path Params

subscriptionId

string

required

Unique identifier of the subscription to update.
Market availability: Global

Body Params

Request body parameters for updating a subscription.

eventType

string

Event type that is subscribed for notifications.
Market availability: Global

eventVersion

string

Version of the event type.
Market availability: Global

resourceName

string

Resource (functional category) that the event type is mapped to.
Market availability: Global

eventUrl

string

Destination URL where notifications are delivered.
Market availability: Global

authDetails

object

Authentication details for accessing the destination URL, if the URL is protected.
Market availability: Global

headers

object

Additional HTTP headers to include when delivering notifications to the destination URL. Use for custom authentication headers, tracking identifiers, or any other headers your endpoint requires.
Market availability: Global

status

string

Status of the subscription. Allowed values are ACTIVE or INACTIVE.
Market availability: Global

Headers

WM_SEC.ACCESS_TOKEN

string

required

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

WM_CONSUMER.CHANNEL.TYPE

string

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

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.
Market availability: Global

WM_SVC.NAME

string

required

Name of the Walmart service being called.
Market availability: Global

WM_MARKET

string

enum

required

Identifies the Walmart Marketplace region for the request. If not specified, US is used by default.
Market availability: Global

Allowed:

WM_GLOBAL_VERSION

string

enum

required

Indicates the global version of the API.
Market availability: Global

Allowed:

Response

200Successful Operation. Returns the updated subscription(s).