API Methods: events.editEvent

Description

Edits or creates an event

Authentication

This method requires authentication with 'write' permission.

API Version

Version 1&2

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.
  • category_id :
    the category_id number of the event.
    If the event_id and category_id parameters are both included, the category_id of the event will be validated.
    If the event_id is not included (creating an event) and category_id is included, the event will be placed in the provided category.
    If neither the event_id nor the category_id are provided, the event will be automatically assigned to the first available valid category.
  • 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.
    If the event_id and group_id parameters are both included, the group_id of the event will be validated.
    If the event_id is not included (creating an event) and group_id is included, the event will be placed in the provided group.
    The user_creator_id is required if the group_id is provided.
  • user_creator_id:
    The user id of the person creating the event. This list of user ids is available from the users.getList method.
    This paramete is required if the event_id is not provided (creating an event) or the group_id parameter is provided.
    If the group_id parameter is provided the user must have the appropriate group permissions to create a group event.
  • 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
  • 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.
  • invite_message :
    the default invitation message for this event
  • show_guests :
    a boolean value which determines if the list of invitees is shown to all the other invitees
  • allow_guests:
    a boolean value which determines if the invitees are allowed to bring guests to the event.
  • link :
    hyperlink for event. Including protocol will make link absolute ("http://")
  • ticket_link :
    hyperlink for event tickets. Including protocol will make link absolute ("http://")
  • price :
    the listed price of the event.
  • description :
    a brief description of the event
  • event_type :
    the type of event. This has two possible values:
    • 0 : Private
    • 1 : Public

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>