Our v3 API is now available! Learn more by visiting the v3 developer portal . Creating new v2 API keys is no longer supported.

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

Description TOP

Privileges required : contacts:lists:write

PUT: Update the name, status of the ContactList specified by the listId path parameter. Performing a PUT overwrites all existing properties for the contactlist resource; any properties left blank or not included in the call will delete those property values prior to the call.

Description TOP

Privileges required : mylibrary:folder:update

Use PUT to modify the following properties for a folder specified by folderId path parameter:

  • update the folder's name
  • change the folder's location in the directory structure by changing it's parent_id
    To move a folder to level 1 in the directory structure, set the parent_id to 0

Description TOP

Privileges required : mylibrary:file:update

Use a PUT call to update the following for a file (specified using the fileId path parameter):

  • Update the name
  • Update the description
  • Move a file to another folder, using folder_id to specify the destination folder.

Description TOP

Privileges required : campaign:write

Update an existing event by using the eventId path parameter.

Description TOP

Privileges required : campaign:write

Update an existing event item; specify the event and the item using the eventId and itemId path parameters.

Description TOP

Privileges required : campaign:write

Update an existing promocode for an event; specify the code and event using the eventId and promocodeId path parameters.

Description TOP

Privileges required : campaign:write

Update an existing fee (specify using feeId ) for an event specified by eventId .

Description TOP

Privileges required : campaign:write

Update an existing item attribute by specifying the eventId , itemId , and attributeId path parameters. Include the attribute name and description in the JSON request body.

NOTE: You cannot change an attribute name once any have been sold to or claimed by event registrants.

Description TOP

Privileges required : campaign:activate

Update the schedule for an email campaign using the scheduleId and campaignId path parameters.

Description TOP

Privileges required : campaign:create

Update an existing email campaign message specified by the campaignId path parameter. For campaigns with a template_type = CUSTOM, all editable fields are available for updating. If template_type = STOCK, the following fields are not available for edit (read-only):

  • text_content
  • email_content
  • style_sheet

These fields can only be updated using the Constant Contact user interface.

NOTE: There are several campaign properties that are optional by default, but become REQUIRED once another property is used. See Structure table below for specific properties.

PUT: https://api.constantcontact.com/v2/eventspot/events/{event_id}

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

eventId

path

Unique ID of the event to update

Example JSON Request Body TOP 

  1. {
  2.     "name": "My Event - October 2013",
  3.     "title": "My Brand New Event",
  4.     "status": "DRAFT",
  5.     "location": "The Atrium on the Wharf",
  6.     "type": "CLASSES_WORKSHOPS",
  7.     "address": {
  8.         "city": "Anytown",
  9.         "state": "Massachusetts",
  10.         "country": "United States",
  11.         "line1": "123 Maple Road",
  12.         "state_code": "MA",
  13.         "country_code": "us",
  14.         "postal_code": "11111"
  15.     },
  16.     "description": "Take your skills to the next level by attending these focused workshops.",
  17.     "contact": {
  18.         "name": "Knowshon Moreno",
  19.         "email_address": "kmoreno@example.com",
  20.         "phone_number": "555-555-5555",
  21.         "organization_name": "The Event Organization"
  22.     },
  23.     "start_date": "2014-08-06T14:00:00.000Z",
  24.     "end_date": "2014-08-08T21:00:00.000Z",
  25.     "time_zone_id": "US/Eastern",
  26.     "is_checkin_available": false,
  27.     "registration_url": "https://events.r20.l1.constantcontact.com/register/event?oeidk=a07e1iw4r2m67314717",
  28.     "theme_name":"Default",
  29.     "payment_address":{
  30.         "city":"My City",
  31.         "line1":"1111 Broadway",
  32.         "state_code":"FL",
  33.         "country_code":"US",
  34.         "postal_code":"11111"
  35.     },
  36.     "paypal_account_email":"jdoe@example.com",
  37.     "payable_to":"The Payee",
  38.     "payment_options":[
  39.         "PAYPAL",
  40.         "CHECK",
  41.         "DOOR"
  42.     ],
  43.     "currency_type": "USD",
  44.     "is_virtual_event": false,
  45.     "notification_options": [
  46.         {
  47.         "notification_type": "SO_REGISTRATION_NOTIFICATION",
  48.         "is_opted_in": true
  49.         }
  50.     ],
  51.     "is_home_page_displayed": false,
  52.     "is_map_displayed": true,
  53.     "is_calendar_displayed": true,
  54.     "is_listed_in_external_directory": false,
  55.     "are_registrants_public": false,
  56.     "track_information": {
  57.         "information_sections": [
  58.             "CONTACT",
  59.             "TIME",
  60.             "LOCATION"
  61.         ],
  62.         "is_registration_closed_manually": false,
  63.         "is_ticketing_link_displayed": false,
  64.         "guest_limit": 0,
  65.         "registration_limit_count": 0,
  66.         "guest_display_label": "Guest(s)",
  67.         "is_guest_name_required": false,
  68.         "is_guest_anonymous_enabled": false
  69.     }
  70. }

Response Codes TOP

code

description

200

Event was successfully updated

400

Either JSON was malformed or there was a data validation error

401

Authentication failure

404

An event with specified ID not found

406

Unsupported accept header value, must be application/json

415

Unsupported content-type in the header, must be application/json

500

Internal server error occurred

Structure TOP

property

type (max length)

description

Example Response TOP 

  1. {
  2.     "id":"a07e1iw4r2m67314717",
  3.     "name":"My Event - October 2013",
  4.     "title":"My Brand New Event",
  5.     "status":"DRAFT",
  6.     "location":"The Atrium on the Wharf",
  7.     "type":"CLASSES_WORKSHOPS",
  8.     "address":{
  9.         "city":"Anytown",
  10.         "state":"Massachusetts",
  11.         "country":"United States",
  12.         "line1":"123 Maple Road",
  13.         "state_code":"MA",
  14.         "country_code":"us",
  15.         "postal_code":"11111"
  16.     },
  17.     "description":"Take your skills to the next level by attending these focused workshops.",
  18.     "contact":{
  19.         "name":"Knowshon Moreno",
  20.         "email_address":"kmoreno@example.com",
  21.         "phone_number":"555-555-5555",
  22.         "organization_name":"The Event Organization"
  23.     },
  24.     "start_date":"2014-08-06T14:00:00.000Z",
  25.     "end_date":"2014-08-08T21:00:00.000Z",
  26.     "created_date":"2013-10-02T18:00:41.644Z",
  27.     "time_zone_id":"US/Eastern",
  28.     "is_checkin_available":false,
  29.     "registration_url":"https://events.r20.l1.constantcontact.com/register/event?oeidk=a07e1iw4r2m67314717",
  30.     "theme_name":"Default",
  31.     "paypal_account_email":"jdoe@example.com",
  32.     "payment_address":{
  33.         "city":"My City",
  34.         "state":"Florida",
  35.         "country":"United States",
  36.         "line1":"1111 Broadway",
  37.         "state_code":"FL",
  38.         "country_code":"us",
  39.         "postal_code":"11111"
  40.     },
  41.     "payable_to":"The Payee",
  42.     "payment_options":[
  43.         "PAYPAL",
  44.         "CHECK",
  45.         "DOOR"
  46.     ],
  47.     "currency_type":"USD",
  48.     "is_virtual_event":false,
  49.     "notification_options":[
  50.         {
  51.         "notification_type":"SO_REGISTRATION_NOTIFICATION",
  52.         "is_opted_in":true
  53.         }
  54.     ],
  55.     "is_home_page_displayed":false,
  56.     "is_map_displayed":true,
  57.     "is_calendar_displayed":true,
  58.     "is_listed_in_external_directory":false,
  59.     "are_registrants_public":false,
  60.     "track_information":{
  61.         "information_sections":[
  62.             "CONTACT",
  63.             "TIME",
  64.             "LOCATION"
  65.         ],
  66.         "is_registration_closed_manually":false,
  67.         "is_ticketing_link_displayed":false,
  68.         "guest_limit":0,
  69.         "registration_limit_count":0,
  70.         "guest_display_label":"Guest(s)",
  71.         "is_guest_name_required":false,
  72.         "is_guest_anonymous_enabled":false
  73.     }
  74. }