API Methods: events.editEvent



Description

Edits or creates an event

Authentication

This method requires authentication with 'write' permission.

Required parameters

  • none

Optional parameters

  • event_id :
    the id number of the event. If this is included, the method will edit an existing event instead of creating a new one. The list of event ids is available from the events.getList call.
  • event_name :
    the name of the event
  • address_1 :
    the first address line of the event location
  • address_2 :
    the second address line of the event location
  • city :
    the city of the event location
  • state :
    the state of the event location
  • country :
    the country of the event location
  • zip_code_5 :
    the five digit zip code of the event location
  • zip_code_4 :
    the plus four zip code of the event location
  • venue :
    the name of the venue for the event
  • start_date :
    the start date and time of the event formatted according to RFC 822 standard or as a Unix time stamp
  • end_date :
    the end date and time of the event formatted according to RFC 822 standard or as a Unix time stamp. If this is omitted, the event will be an all day event.
  • group_id :
    the id of the group to which this event belongs. This will place the event in the group's calendar rather than the site or user's calendars. The list of group ids is available from the groups.getList call.
  • invite_message :
    the default invitation message for this event
  • ask_rsvp :
    a boolean value (0=false, 1=true) which determines if the invitees are asked to rsvp for the event
  • show_guests :
    a boolean value which determines if the list of invitees is shown to all the other invitees
  • description :
    a brief description of the event
  • event_type :
    the type of event. This has three possible values:
    • 0 : Private
    • 1 : Group
    • 2 : Public
  • ss_key : the key of the community associated with the event. The list of communities is available from the communities.getList call.
  • interest_key : the key of a site interest associated with the event. The list of interests is available from the siteinterests.getList call.
  • subinterest_key : the key of a site sub-interest associated with the event. The list of interests is available from the siteinterests.getList call.

Example response

<?xml version="1.0"?>
<response status="ok" time="Mon, 21 Apr 2008 13:50:31 -0500">
    <events count="1">
        <event>
            <event_id>21</event_id>
        </event>
    </events>
</response>