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

Description TOP

Privileges required : campaign:write

The API uses the PATCH method to publish or cancel an event by only changing the value of the event's status property:

Publishing an event changes status from DRAFT to ACTIVE
Cancelling an event changes status from ACTIVE to CANCELLED

The PATCH method allows partial resource modifications, as opposed to a PUT which rewrites the entire resource. The JSON request body for a PATCH provides instructions for the changes that need to be made to the event object:

The operation to perform - only the REPLACE operation is supported:
"op":"REPLACE"
where in the object to perform it - only the path value "#/status" is allowed:
"path":#/status
the new value to write - only the values "ACTIVE" and "CANCELLED are allowed :
"value":"ACTIVE"

Because the PATCH method is a partial resource modification, the request payload shown below is very different than the response payload shown in the Response Structure section.

See IETF RFC 5789 and RFC 6902 for more information.

name	type	description
PATCH: 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 publish or cancel

Example JSON Request Body TOP

[{"op":"REPLACE",
  "path":"#/status",
  "value":"ACTIVE"}]

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

{
    "id":"a07e1iw4qte312ceae8",
    "name":"My Event - October 2013",
    "title":"My Brand New Event",
    "status":"ACTIVE",
    "location":"The Atrium on the Wharf",
    "type":"CLASSES_WORKSHOPS",
    "address":{
        "city":"Anytown",
        "state":"Massachusetts",
        "country":"United States",
        "line1":"123 Maple Road",
        "line2":"",
        "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-02T15:45:15.725Z",
    "time_zone_id":"US/Eastern",
    "active_date":"2013-10-02T17:42:43.443Z",
    "is_checkin_available":false,
    "registration_url":"https://events.r20.l1.constantcontact.com/register/event?oeidk=a07e1iw4qte312ceae8",
    "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
    }
}