You can use this API to suspend a promotion at the organization level.

• When you deactivate a promotion globally, the system immediately stops evaluating it during cart processing. The promotion will no longer apply to any customers, regardless of their eligibility or previous targeting rules.
• Use this API when you need to retire a cart promotion, end a seasonal offer early, or temporarily pause a promotion across the entire organization.
• If you only need to deactivate a promotion for a specific customer while keeping it active for others, use the Deactivate Promotion for Customer API instead.

Example request

curl --location --request PUT 'https://{Host}/api_gateway/v1/promotions/{Promotionid}/deactivate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Z2VvcmdlLmRvY2RlbW86NjVhMDgzYjk1MWNTY5NDk1YmNkNzUxYmJiY2U=' \
--header 'Cookie: _cfuvid=JTn6J5w_XI6I54S9i2lJMz39zEaGAvDWdREw-1770697785684-0.0.1.1-604800000'

Prerequisites

• Authentication: Basic or OAuth authentication.
• Default access group

Path parameters

Example response

{
    "data": true,
    "errors": []
}

Response parameters

Error codes