Individual Events | Constant Contact Developer

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

GET PUT PATCH

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.

name	type	description
GET: https://api.constantcontact.com/v2/eventspot/events/{event_id}
Test API
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

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 is_map_displayed set to true.

city	string (50)	City of the event location
country	string (128)	Country of the event location
country_code	string (2)	Standard 2 letter ISO 3166-1 code of the country associated with the event address
latitude	number	Latitude coordinates of the event location, not used to determine event Location on map if `is_map_displayed` set to true
line1	string (50)	Event address line 1
line2	string (50)	Event address line 2
line3	string (50)	Event address line 3
longitude	number	Longitude coordinates of the event location, , not used to determine event Location at this time on map if `is_map_displayed` set to true
postal_code	string (25)	Postal ZIP code for the event
state	string (50)	Name of the state or province the event is located in. For US or CA, this field is overwritten by the state/province name derived from the `state_code`, if entered.
state_code	string (50)	Use ONLY for the standard 2 letter abbreviation for the US state or Canadian province where the event is located; An error occurs if `state_code` is populated for non-US or Canadian country; if `state_code` is entered, the system overwrites the `state` property with the resolved state or province name.

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

email_address	string (128)	Event contact's email-address
name	string (100)	Name of the person conducting or managing the event
organization_name	string (255)	Event contact's organization name
phone_number	string (25)	Event contact's phone number

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.
Valid values are: USD, CAD, AUD, CHF, CZK, DKK, EUR, GBP, HKD, HUF, ILS, JPY, MXN, NOK, NZD, PHP, PLN, SEK, SGD, THB, TWD

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.

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 email_address, and which notifications.

is_opted_in	boolean	Set to true to send event notifications to the contact `email_address`, false for no notifications; default = false
notification_type	string	Specifies the type of notifications sent to the contact `email_address`, valid values: SO_REGISTRATION_NOTIFICATION - send notice for each registration (Default)

+ online_meeting

array

Online meeting details, REQUIRED if is_virtual_event is set to true

instructions	string (2500)	Online meeting instructions, such as dial in number, password, etc
provider_meeting_id	string (50)	Meeting ID, if any, for the meeting
provider_type	string (20)	Specify the online meeting provider, such as WebEx
url	string (250)	URL for online meeting. REQUIRED if `is_virtual_event` is set to true.

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

city	string (50)	Payment address city
country	string (128)	Country of the payment address
country_code	string (2)	Standard 2 letter ISO 3166-1 code of the country associated with the payment address
latitude	number	Latitude coordinate of the payment address
line1	string (50)	Address line 1
line2	string (50)	Address line 2
line3	string (50)	Address line 3
longitude	number	Longitude coordinate of the payment address
postal_code	string (25)	ZIP code.
state	string (50)	State or Canadian province name; any user input is overwritten by state or province name derived from the `state_code` entered.
state_code	string (2)	Standard 2 letter abbreviation for event's state or province; if state code is entered, the system overwrites the `state` property with resolved state name.

+ payment_options

array

Specifies the payment options available to registrants

payment_types

string

Payment type(s) accepted for the event, multiple types allowed:

ONLINE_CREDIT_CARD_PROCESSOR - not supported for new events starting November 2013
PAYPAL
GOOGLE_CHECKOUT - Not supported for new events as of October 2013
CHECK - if selected, payment_address and payable_to are REQUIRED
DOOR - payment is accepted at the door

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:

DRAFT
ACTIVE - Event is published and publicly accessible
COMPLETE - Event has occurred and is complete
CANCELLED - Event is no long publicly accessible
DELETED

When an event is published, status transitions from DRAFT to ACTIVE.
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

early_fee_date	string	Date on which early fees end, in ISO-8601 format
guest_display_label	string (50)	Default = Guest(s); How guests are referred to on the registration form; use your own, or one of the following suggestions are Associate(s), Camper(s), Child(ren), Colleague(s), Employee(s), Friend(s), Guest(s), Member(s), Participant(s), Partner(s), Player(s), Spouse(s), Student(s), Teammate(s), Volunteer(s)
guest_limit	integer	Number of guests each registrant can bring, 0 - 100, default = 0
information_sections	array	Determines if the Who (CONTACT), When (TIME), or Where (LOCATION) information is shown on the Event page. Default settings are CONTACT, TIME, and LOCATION ; valid values are: CONTACT - displays the event contact information TIME - displays the event date and time LOCATION - displays the event location
is_guest_anonymous_enabled	boolean	Default = false; Set to true to display the guest count field on the registration form; if true, `is_guest_name_required` must be set to false (default).
is_guest_name_required	boolean	Default = false. Set to display guest name fields on registration form; if true, then `is_guest_anonymous_enabled` must be set false (default).
is_registration_closed_manually	boolean	Default = false; Manually closes the event registration when set to true, takes precedence over `registration_limit_date` and `registration_limit_count` settings
is_ticketing_link_displayed	boolean	Default = false; Set to true provide a link for registrants to retrieve an event ticket after they register.
late_fee_date	string	Date after which late fees apply, in ISO-8601 format
registration_limit_count	integer	Specifies the maximum number of registrants for the event
registration_limit_date	string	Date when event registrations close, in ISO-8601 format

twitter_hash_tag

string (30)

The event's Twitter hashtag

type

string

The event type, valid values are:
AUCTION, BIRTHDAY, BUSINESS_FINANCE_SALES
CLASSES_WORKSHOPS, COMPETITION_SPORTS
CONFERENCES_SEMINARS_FORUM, CONVENTIONS_TRADESHOWS_EXPOS
FESTIVALS_FAIRS, FOOD_WINE, FUNDRAISERS_CHARITIES
HOLIDAY, INCENTIVE_REWARD_RECOGNITION, MOVIES_FILM
MUSIC_CONCERTS, NETWORKING_CLUBS, PERFORMING_ARTS
OUTDOORS_RECREATION, RELIGION_SPIRITUALITY
SCHOOLS_REUNIONS_ALUMNI, PARTIES_SOCIAL_EVENTS_MIXERS
TRAVEL, WEBINAR_TELESEMINAR_TELECLASS
WEDDINGS, OTHER

updated_date

string

Date the event was updated in ISO-8601 format

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
    }
}