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: 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.
Privileges required: mylibrary:folder:update
Use PUT to modify the following properties for a folder specified by folderId
path parameter:
name
parent_id
parent_id
to 0Privileges required: mylibrary:file:update
Use a PUT call to update the following for a file (specified using the fileId
path parameter):
name
folder_id
to specify the destination folder.
Privileges required: campaign:write
Update an existing event by using the eventId
path parameter.
Privileges required: campaign:write
Update an existing event item; specify the event and the item using the eventId
and itemId
path parameters.
Privileges required: campaign:write
Update an existing promocode for an event; specify the code and event using the eventId
and promocodeId
path parameters.
Privileges required: campaign:write
Update an existing fee (specify using feeId
) for an event specified by eventId
.
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.
Privileges required: campaign:activate
Update the schedule for an email campaign using the scheduleId
and campaignId
path parameters.
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):
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} |
|||
name |
type |
default |
description |
---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
eventId |
path |
Unique ID of the event to update |
{ "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-06T14:00:00.000Z", "end_date": "2014-08-08T21:00:00.000Z", "time_zone_id": "US/Eastern", "is_checkin_available": false, "registration_url": "https://events.r20.l1.constantcontact.com/register/event?oeidk=a07e1iw4r2m67314717", "theme_name":"Default", "payment_address":{ "city":"My City", "line1":"1111 Broadway", "state_code":"FL", "country_code":"US", "postal_code":"11111" }, "paypal_account_email":"jdoe@example.com", "payable_to":"The Payee", "payment_options":[ "PAYPAL", "CHECK", "DOOR" ], "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 } }
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 |
property |
type(max length) |
description |
---|
{ "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-06T14:00:00.000Z", "end_date":"2014-08-08T21: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", "paypal_account_email":"jdoe@example.com", "payment_address":{ "city":"My City", "state":"Florida", "country":"United States", "line1":"1111 Broadway", "state_code":"FL", "country_code":"us", "postal_code":"11111" }, "payable_to":"The Payee", "payment_options":[ "PAYPAL", "CHECK", "DOOR" ], "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 } }