BCL icon

BCL

Consume BCL Payment API

Coupon → Update Status

AI-generated

Overview

This node updates the status of a coupon in the BCL Payment API. It is useful for enabling or disabling a coupon's active state, which controls whether the coupon can be applied in transactions. For example, a user can activate a coupon to make it available for use or deactivate it to prevent its usage.

Use Case Examples

  1. Activate a coupon by setting its status to active.
  2. Deactivate a coupon to temporarily disable it from being used.

Properties

Name Meaning
Coupon ID The unique identifier of the coupon to update. This is required to specify which coupon's status will be changed.
Is Active Boolean flag indicating whether the coupon should be active (true) or inactive (false).

Output

JSON

  • json - The JSON response from the BCL API after updating the coupon status, containing details of the updated coupon.

Dependencies

  • BCL Payment API with an API token credential

Troubleshooting

  • Authentication failed errors indicate invalid or expired API token; verify and update credentials.
  • Validation errors mean the input parameters are incorrect or incomplete; check required fields and data types.
  • Bad request errors suggest malformed requests; ensure all parameters are correctly formatted.
  • Forbidden errors indicate lack of permission; verify API token permissions.
  • Not found errors mean the specified coupon ID does not exist; confirm the coupon ID is correct.
  • Server errors indicate issues on the BCL server side; retry later or contact support.

Discussion