Update a Coupon

Updates a coupon by the given id.

put

Path parameters

idstringRequired

The id of the coupon.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

This class is used to provide a data transfer object for the coupon which is used for command requests.

typestring · enumRequired

The type of the coupon.

Possible values:

namestring · min: 1Required

The name of the coupon.

codestring · min: 1Required

The code of the coupon.

percentOffnumber · double · max: 100 · nullableOptional

The percentage of the coupon.

maxRedemptionsinteger · int32 · max: 2147483647 · nullableOptional

A positive integer specifying the number of times the coupon can be redeemed before it’s no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.

startDatestring · date-timeRequired

The start date and end date of the coupon.

endDatestring · date-timeRequired

The end date of the coupon.

autoApplyToPricebooleanOptional

Is the coupon auto apply to price. If true, the coupon will be applied to the price automatically. By default, the value is false.

descriptionstring · nullableOptional

The description of the coupon.

tagsstring · nullableOptional

The tags of the coupon.

statusstring · enumOptional

Provides the status of the coupon.

Possible values:

testModeboolean · nullableOptional

The test mode of the coupon. By default, the value is false.

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

/api/v1/coupons/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/coupons/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 249

{
  "type": "Percent",
  "name": "text",
  "code": "text",
  "percentOff": 1,
  "maxRedemptions": 1,
  "startDate": "2026-04-04T13:28:35.160Z",
  "endDate": "2026-04-04T13:28:35.160Z",
  "autoApplyToPrice": true,
  "description": "text",
  "tags": "text",
  "status": "Active",
  "testMode": true
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "code": "COUPON1",
    "name": "Coupon 1",
    "description": "This is a coupon",
    "tags": "tag1, tag2",
    "percentOff": 10,
    "timesRedeemed": 0,
    "maxRedemptions": 100,
    "startDate": "2026-01-26T08:03:23.744361+07:00",
    "endDate": "2026-02-25T08:03:23.744362+07:00",
    "autoApplyToPrice": true,
    "status": "Active",
    "testMode": false,
    "modifiedDate": "2026-01-26T08:03:23.744362+07:00"
  },
  "errors": []
}