Update a Coupon

Update the settings or content of a coupon definition.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Expiration Overrides

By default, a coupon's expiration is determined by its valid_until attribute. However, if needed, you can override this expiration. Overrides can be applied both at the time of assignment and activation. These expiration rules do not apply to the Coupon entity itself but rather to the User Coupon entity, which is a duplicate of the original coupon but treated as a unique instance for each customer.

Expiration Override on Assignment
A coupon is assigned when it is directly given to a member via an API call, through the Content Cockpit, as a reward from Contests or Promo Events, or as part of a predefined Scenario.

Expiration Override on Activation
A coupon is activated when a member activates it manually via a mobile app, e-commerce website, or client portal. Activation can also occur automatically if Coupon Preactivation is enabled globally or if the coupon is flagged as Always Activated.

Expiration Types
There are three types of expiration overrides: absolute, relative, and period based.

  • Absolute: Defines a specific timestamp when the User Coupon should expire.
  • Relative: Sets an expiration period in units (seconds, hours, days...) starting from when the coupon is assigned or activated.
  • Period: Expires the User Coupon at the end of a predefined period, such as an hour, day, week, month, quarter, or year.
Path Params
string
required

UUID of Coupon

Body Params
string
required
Defaults to My awesome Coupon
string
required
Defaults to Description for my awesome coupon.
string
enum
required
Defaults to STANDARD
Allowed:
boolean
required
Defaults to true
string
required

UUID of Image

string
required

UUID of Image

boolean
Defaults to false
boolean
Defaults to false

Set true if one member can redeem this coupon multiple time

boolean
Defaults to false

Set true if this coupon should be activated after assignment

int32
Defaults to null

Points value of coupon in cents (123 points = 12300). If null coupon can be activated for free.

int32
Defaults to 1627024593

UNIX Timestamp

int32
Defaults to 1698054593

UNIX Timestamp

int32
Defaults to 1699054593

UNIX Timestamp

expiration_override_on_assignment
object

Override coupon expiration on assignment. Null for no expiration override.

expiration_override_on_activation
object

Override coupon expiration on activation. Null for no expiration override.

categories
array of strings

UUID's of Categories

categories
segments
array of strings

UUID's of Segments

segments
json
Defaults to {}
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json