Skip to content
Cohost API

Update an existing coupon

PATCH
/v1/coupons/{id}

Update an existing coupon by ID for the authenticated company

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
Example
coupon_123abc

The unique identifier of the coupon to update

Request Body required

Section titled “Request Body required ”
object
description
string
code
string
type
string
Allowed values: access coded public hold
amountOff
number
percentOff
number
limit
number
offeringIds
Array<string>
contextIds
Array<string>
Example
{
  "code": "UPDATED2024",
  "discountValue": 25,
  "maxUses": 150
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successfully updated coupon

object
status
string
Example
ok
data
object
id
string
companyId
string
description
string
code
string
type
string
Allowed values: access coded public hold
amountOff
number
percentOff
number
limit
number
quantitySold
number
offeringIds
Array<string>
contextIds
Array<string>
status
string
Allowed values: active expired disabled sold_out

400

Section titled “400 ”

Bad request - invalid coupon data

object
status
string
Example
error
message
string
Example
An error occurred
error
string

401

Section titled “401 ”

Unauthorized - authentication required

object
status
string
Example
error
message
string
Example
An error occurred
error
string

404

Section titled “404 ”

Coupon not found

object
status
string
Example
error
message
string
Example
An error occurred
error
string

500

Section titled “500 ”

Internal server error

object
status
string
Example
error
message
string
Example
An error occurred
error
string