Create Discount Code

post

https://api.swoogo.com/api/v1/discounts/create

Creates a new discount code for an event. Requires event_id, code, and type (percentage, absolute, or specific). Set capacity to limit total usage, apply_to_all to apply across every line item, or list specific items in applicable_line_items for targeted discounts. For specific-type discounts, supply line-item-specific fees via custom_fees_update. Group constraints can be configured via min_group_size, registrants_per_use, and all_registrants_in_group.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

event_id

integer

required

ID of the event to which this discount is associated.

code

string

required

length ≤ 255

Unique code for the discount within the event. May not contain <, >, \, or ".

type

string

enum

required

The type of discount being applied.

percentage — percentage_discount is required.
absolute — absolute_discount is required.
specific — line-item-specific fees are supplied via custom_fees_update.

Allowed:

percentage_discount

float

0 to 100

Percentage value of the discount. Required when type is percentage.

absolute_discount

float

Absolute monetary value of the discount. Required when type is absolute.

apply_to_all

boolean

If true, the discount applies to every line item; if false, only to those listed in applicable_line_items.

capacity

integer

Maximum number of times this discount can be used. Omit (or 0) for unlimited.

min_group_size

integer

≥ 2

Minimum group size required to use this discount.

registrants_per_use

integer

≥ 2

Maximum number of times the code can be used per group of N registrants. e.g. set to 2 to allow 1 use in a group of 2, 2 uses in a group of 4, etc.

all_registrants_in_group

boolean

Whether all registrants in a group must use the same discount.

applicable_line_items

array of strings

Line items the discount applies to when apply_to_all is false. Standard values are
reg_type, package, and session. Custom-question line items use the form c_<questionId>
(e.g. c_438).

applicable_line_items

custom_fees_update

object

For specific discounts: maps each line-item type to a map of line-item IDs and the
replacement fee (as a string). On save, these entries are merged into the persisted
custom_fees object. Returned only via the custom_fees field on read responses.

autopopulate_attributes

array of objects

Registrant fields to be automatically populated when this discount is applied. Each entry
has an attribute (registrant attribute name or c_<questionId> for custom questions)
and a value.

autopopulate_attributes

notes

string

Free-form notes or comments about the discount.

sold_out_message

string

length ≤ 255

Custom message shown when the discount is sold out. Defaults to a generic message when not set.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

access_token

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created

401Authentication failed. The bearer token is missing, expired, or invalid. Obtain a new token via POST /oauth2/token.

403The authenticated user does not have permission to access this resource. This can occur if the resource belongs to a different account or the API credentials lack the required scope.

404The specified resource does not exist or has been deleted. Verify the ID is correct and that the resource belongs to an event your credentials have access to.

500An unexpected server error occurred. If this persists, contact Swoogo support with the request details and timestamp.