Disable promotion

This API is used to disable a catalog promotion for a particular brand.

πŸ“˜

Note

  • To disable a promotion, set status=false in the URL.
  • Disabled Promotion cannot be enabled again.

πŸ‘

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URI/api_gateway/rewards/core/v1/promotion/{promotion Id}/status/false/brand/{brand Id}
HTTP MethodPUT
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/promotion/2/status/false/brand/1

Request path parameters

ParametersData TypeDescription
Promotion Id*StringUnique identifier for the promotion. Ex: 2
Brand ID*StringUnique identifier for the brand. Ex: 1
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/promotion/2/status/false/brand/1

Response parameters

Parameter NameData TypeDescription
statusObjectContains the status information of the request.
successBooleanIndicates the status of the request.
codeIntegerThe status code of the response.
messageStringThe message describing the status.
{
   "status": {
       "success": true,
       "code": 11011,
       "message": "Catalog promotion status updated successfully."
   }
}

API-specific error code

Error codesDescription
11013Catalog promotion is disabled.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!