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.
Click a method to view its documentation
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.
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 |
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 |
property |
type(max length) |
description |
|||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
active_date |
string |
Date event was published or announced, in ISO-8601 format |
|||||||||||||||||||||||||||||||||
+ address |
object |
Address specifying the event location, used to determine event location on map if |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||
are_registrants_public |
boolean |
Set to true allows registrants to view others who have registered for the event, default = false |
|||||||||||||||||||||||||||||||||
cancelled_date |
string |
Date the event was cancelled in ISO-8601 format |
|||||||||||||||||||||||||||||||||
+ contact |
object |
The event host's contact information |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||
created_date |
string |
Date the event was created in ISO-8601 format |
|||||||||||||||||||||||||||||||||
currency_type |
string |
Currency that the account will be paid in; although this is not a required field, it has a default value of USD. |
|||||||||||||||||||||||||||||||||
deleted_date |
string |
Date the event was deleted in ISO-8601 format |
|||||||||||||||||||||||||||||||||
description |
string (350) |
Provide a brief description of the event that will be visible on the event registration form and landing page |
|||||||||||||||||||||||||||||||||
end_date |
string |
The event end date, in ISO-8601 format |
|||||||||||||||||||||||||||||||||
google_analytics_key |
string (20) |
Enter the Google analytics key if being used to track the event registration homepage |
|||||||||||||||||||||||||||||||||
google_merchant_id |
string (20) |
Google merchant id to which payments are made; Google Checkout is not supported for new events, only valid on events created prior to October 2013. |
|||||||||||||||||||||||||||||||||
id |
string (26) |
Unique ID of the event |
|||||||||||||||||||||||||||||||||
is_calendar_displayed |
boolean |
Set to true to display the event on the account's calendar; Default = true |
|||||||||||||||||||||||||||||||||
is_checkin_available |
boolean |
Set to true to enable registrant check-in, and indicate that the registrant attended the event; default = false |
|||||||||||||||||||||||||||||||||
is_home_page_displayed |
boolean |
Indicates if the event home/landing page is displayed for the event; set to true only if a landing page has been created for the event; default = false |
|||||||||||||||||||||||||||||||||
is_listed_in_external_directory |
boolean |
Set to true to publish the event in external event directories such as SocialVents and EventsInAmerica; default = false |
|||||||||||||||||||||||||||||||||
is_map_displayed |
boolean |
For future usage, Default = true |
|||||||||||||||||||||||||||||||||
is_virtual_event |
boolean |
Set to true if this is an online event; default = false |
|||||||||||||||||||||||||||||||||
location |
string (50) |
Name of the venue or location at which the event is being held |
|||||||||||||||||||||||||||||||||
meta_data_tags |
string (100) |
Specify keywords to improve search engine optimization (SEO) for the event; use commas to separate multiple keywords |
|||||||||||||||||||||||||||||||||
name |
string (100) |
The event filename - not visible to registrants |
|||||||||||||||||||||||||||||||||
+ notification_options |
array |
Define whether or not event notifications are sent to the contact |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||
+ online_meeting |
array |
Online meeting details, REQUIRED if |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||
payable_to |
string (128) |
Name to which registrants paying by check must make checks payable to; REQUIRED if 'CHECK' is selected as a payment option |
|||||||||||||||||||||||||||||||||
+ payment_address |
object |
Address to which checks will be sent. REQUIRED if CHECK is selected as a payment option |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||
+ payment_options |
array |
Specifies the payment options available to registrants |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||
paypal_account_email |
string (128) |
Email address linked to PayPal account to which payments will be made. REQUIRED if 'PAYPAL' is selected as a payment option |
|||||||||||||||||||||||||||||||||
registration_url |
string (250) |
For events that have a homepage configured (via the product GUI), the registration_url points to the event homepage, otherwise it points to the event registration page. |
|||||||||||||||||||||||||||||||||
start_date |
string |
The event start date, in ISO-8601 format |
|||||||||||||||||||||||||||||||||
status |
string |
The event status, valid values are:
When an event is cancelled, status transitions from ACTIVE to CANCELLED. |
|||||||||||||||||||||||||||||||||
theme_name |
string |
The theme_name defines the layout and style (including background and color) for the event invitation, home page, and Registration form, see Event Themes for a list of all available themes; default = Default |
|||||||||||||||||||||||||||||||||
time_zone_description |
string (80) |
Specify additional text to help describe the event time zone |
|||||||||||||||||||||||||||||||||
time_zone_id |
string (40) |
Time zone in which the event occurs, to see time_zone_id values go here. |
|||||||||||||||||||||||||||||||||
title |
string (100) |
The event title, visible to registrants |
|||||||||||||||||||||||||||||||||
total_registered_count |
integer |
Number of event registrants |
|||||||||||||||||||||||||||||||||
+ track_information |
array |
Use these settings to define the information displayed on the Event registration page |
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||
twitter_hash_tag |
string (30) |
The event's Twitter hashtag |
|||||||||||||||||||||||||||||||||
type |
string |
The event type, valid values are: |
|||||||||||||||||||||||||||||||||
updated_date |
string |
Date the event was updated in ISO-8601 format |
{ "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 } }