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

Field	Type	Required	Description
promotionId	String	Yes	The unique identifier of the promotion to be deactivated globally.

Example response

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

Response parameters

Field	Type	Description
data	Boolean	Returns true if the global deactivation was successful.
errors	Array	A list of error objects (empty on success).

Error codes

Code	Description
400	GLOBAL.INVALID_INPUT: Malformed request or invalid promotionId format.
404	GLOBAL.PROMOTION_NOT_FOUND: The promotion configuration was not found for the given organization.
725	PROMO.PROMOTION_ID_INVALID: The provided ID is not in a valid format.
811	PROMO.UPDATE_EXPIRY_DATE_NOT_ALLOWED: Status change is blocked because an expiry date update job is currently running on this promotion.
500	GLOBAL.UNEXPECTED_ERROR: Internal server error.

200Successful response