Create a coupon list

Prev Next
Post
/couponList/create

Creates an empty list owned by the authenticated caller. Name must contain 3-50 alphanumeric characters. Optional previewText accepts up to 200 characters; optional defaultText accepts up to 500 characters. Does not accept coupon codes. Reminders are disabled by default. Supply a non-negative remindThreshold to enable them; zero means remind when empty. additionalReminderEmail is an optional recipient (maximum 200 characters).

Body parameters

Settings for a new coupon list. Name is required.

object
name
string Required

List name: 3-50 alphanumeric characters, stored in lowercase. Required when creating a list.

description
string

Optional description, up to 500 characters.

previewText
string

Placeholder used instead of a real coupon code in message previews; up to 200 characters. Unset or empty uses the list name followed by _previewCoupon.

defaultText
string

Fallback text used when no coupon code is available during sendout; up to 500 characters. Optional; no fallback is configured when omitted.

reminderEnabled
boolean

False disables reminders and clears the threshold and additional recipient. True requires a supplied or existing threshold. Omitted or null preserves settings on update.

Defaultfalse
remindThreshold
integer (int64)

Non-negative available-code count at or below which the owner is reminded. Zero means remind when empty. Supplying it enables reminders; conflicts with reminderEnabled=false. Omitted or null preserves the threshold on update.

additionalReminderEmail
string

Optional additional recipient: valid email, up to 200 characters. Requires enabled reminders. Empty clears it; omitted or null preserves it on update.

Responses
200

Identifier of the newly created empty coupon list.

integer (int64)
400

InvalidParameterException / MISSING_PARAMETER: settings is missing; INVALID_PARAMETER: name must contain 3-50 alphanumeric characters, description or defaultText exceeds 500 characters, or previewText exceeds 200 characters; reminder settings are inconsistent, the threshold is negative, or the additional recipient is invalid or exceeds 200 characters.
ObjectAlreadyExistsException / OBJECT_ALREADY_EXISTS: name is already used in this customer, including archived lists; names are stored in lowercase.
UnexpectedErrorException / PERMISSION_DENIED: caller lacks permission to create a coupon list.

object
errorActor
string
errorCode
string
message
string
500

UnexpectedErrorException / UNEXPECTED_ERROR: a backend operation failed; errorActor is SERVER.

object
errorActor
string
errorCode
string
message
string