Use this API endpoint to retrieve (GET), update (PUT), or DELETE an existing event fee promocode.
Click a method to view its documentation
Privileges required: campaign:read
Retrieve a specific promotional code for an event; use the promocodeId
and eventId
path parameters to specify the code and the event it belongs to.
GET: https://api.constantcontact.com/v2/eventspot/events/{eventId}/promocodes/{promocodeId} |
|||
name |
type |
default |
description |
---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
eventId |
path |
Unique ID of the event for which to retrieve the promocode |
|
promocodeId |
path |
Unique ID of the promocode to retrieve |
code |
description |
---|---|
200 |
Request was successful |
401 |
Authentication failure |
404 |
Either an event could not be found for the eventId or a promocode could not be found for the promocodeId provided |
406 |
Unsupported Accept Header value, must be application/json |
500 |
Internal server error occurred |
property |
type(max length) |
description |
---|---|---|
code_name |
string (12) |
Name of the promotional code visible to registrants, between 4 - 12 characters, cannot contain spaces or special character (_ is OK); each code_name must be unique |
code_type |
string |
Type of promocode:
|
discount_amount |
number |
Specifies a fixed discount amount, minimum of 0.01, is required when |
discount_percent |
integer |
Specifies a discount percentage, from 1% - 100%, is required when |
discount_scope |
string |
Required when
|
discount_type |
string |
Discount types:
|
fee_ids |
array |
Identifies the fees to which the promocode applies;
|
id |
string (50) |
Unique ID for the event promotional code |
is_paused |
boolean |
When set to true, promocode cannot be redeemed; when false, promocode can be redeemed; default = false. |
quantity_available |
integer |
Number of promocodes available for redemption; -1 = unlimited. |
quantity_total |
integer |
Total number of promocodes available for redemption; -1 = unlimited. |
quantity_used |
integer |
Number of promocodes that have been redeemed; starts at 0. |
status |
string |
Status of the promocode:
|
{ "id":"MIT4bfRPOntYqxSKs2ui9rIwqpZ7nzW2Y09fUs00t3Q", "status":"LIVE", "code_name":"TOTAL_FEE", "is_paused":false, "fee_ids":[ "MIT4bfRPOntYqxSKs2ui9oPJUvBGM9P1V53KQcYO8Aw" ], "quantity_total":-1, "quantity_used":0, "quantity_available":-1, "code_type":"DISCOUNT", "discount_scope":"FEE_LIST", "discount_type":"PERCENT", "discount_percent":33 }