Individual Promocode Endpoint
Use this API endpoint to retrieve (GET), update (PUT), or DELETE an existing event fee promocode.
Methods:
Click a method to view its documentation
DescriptionTOP
Retrieve a specific partner webhook topic by specifying the topicId path parameter. See the available topic ID's here.
DescriptionTOP
Privileges required: campaign:read
Retrieves the email campaign message specified by the campaignId path parameter. The tracking_summary data is current as of the last scheduled update, unless you set updateSummary=true to return updated data.
NOTE: Details of a deleted campaign cannot be retrieved. If a call is made to GET a deleted campaign by its ID, the call will fail and return a 404 Not Found response. You can login to the account to restore the campaign and then retrieve its details.
DescriptionTOP
Privileges required: contacts:lists:read
GET a specific contact list (specified using the listId path parameter).
DescriptionTOP
Privileges required: mylibrary:folder:read
Retrieve a specific MyLibrary folder using the folderId path parameter.
DescriptionTOP
Privileges required: mylibrary:file:read
Retrieve a MyLibrary file using the fileId path parameter.
DescriptionTOP
Privileges required: campaign:read
Retrieve an event item by using the eventId and itemId path parameters to specify the event and item.
DescriptionTOP
Privileges required: campaign:read
Retrieve a list of all items for an event specified using the eventId path parameter.
DescriptionTOP
Privileges required: campaign:read
Get a specific event object (specified by the event_id path parameter). Properties with a null value are not returned in the JSON response.
DescriptionTOP
Privileges required: campaign:read
Retrieve detailed information about a specific registrant (specified by registrantId) for an event (specified by eventId).
DescriptionTOP
Privileges required: campaign:read
Retrieve the collection of all registrants for the event specified using the event_id path parameter.
|
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 |
|
Response CodesTOP
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 |
StructureTOP
|
property |
type(max length) |
description |
|---|
Example ResponseTOP
{
"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
}