Individual Event API
Use this API to retrieve (GET), update (PUT), or Publish/Cancel (PATCH) an existing event. To create a new event, use the Events Collection API POST method.
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/{event_id} |
|||
name |
type |
default |
description |
|---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
eventId |
path |
Unique ID of the event to retrieve |
|
Response CodesTOP
code |
description |
|---|---|
200 |
Request was successful |
401 |
Authentication failure |
404 |
Event with the supplied ID was not found |
406 |
Unsupported Accept Header value, must be application/json |
500 |
Internal server error occurred |
StructureTOP
|
property |
type(max length) |
description |
|---|
Example ResponseTOP
{
"id":"a07e1iw4r2m67314717",
"name":"My Event - October 2013",
"title":"My Brand New Event",
"status":"DRAFT",
"location":"The Atrium on the Wharf",
"type":"CLASSES_WORKSHOPS",
"address":{
"city":"Anytown",
"state":"Massachusetts",
"country":"United States",
"line1":"123 Maple Road",
"state_code":"MA",
"country_code":"us",
"postal_code":"11111"
},
"description":"Take your skills to the next level by attending these focused workshops.",
"contact":{
"name":"Knowshon Moreno",
"email_address":"kmoreno@example.com",
"phone_number":"555-555-5555",
"organization_name":"The Event Organization"
},
"start_date":"2014-08-03T14:00:00.000Z",
"end_date":"2014-08-05T21:00:00.000Z",
"created_date":"2013-10-02T18:00:41.644Z",
"time_zone_id":"US/Eastern",
"is_checkin_available":false,
"registration_url":"https://events.r20.l1.constantcontact.com/register/event?oeidk=a07e1iw4r2m67314717",
"theme_name":"Default",
"currency_type":"USD",
"is_virtual_event":false,
"notification_options":[
{
"notification_type":"SO_REGISTRATION_NOTIFICATION",
"is_opted_in":true
}
],
"is_home_page_displayed":false,
"is_map_displayed":true,
"is_calendar_displayed":true,
"is_listed_in_external_directory":false,
"are_registrants_public":false,
"track_information":{
"information_sections":[
"CONTACT",
"TIME",
"LOCATION"
],
"is_registration_closed_manually":false,
"is_ticketing_link_displayed":false,
"guest_limit":0,
"registration_limit_count":0,
"guest_display_label":"Guest(s)",
"is_guest_name_required":false,
"is_guest_anonymous_enabled":false
}
}