This documentation relates to CiviCRM version 3.2. It's not maintained anymore.
Current version of documentation.

Event APIs

Skip to end of metadata
Go to start of metadata

This page refers to outdated version of CiviCRM. Check current version of documentation.


Documentation Search


CiviCRM 3.2 Documentation

Support and Participation

Developer Resources


CiviCRM book!

Make sure to check out Understanding CiviCRM as well! You can also support this project by ordering a hard copy.

Event APIs

civicrm_event_create($params)

Availability: v1.8

This API is used for creating / updating an Event.

Parameters:

  • 'params' (array) an associative array of title/value property values of civicrm_event
  • for updating an event pass event id in array like $params['event_id']

Returns:

  • array of newly created event property values.
    Create Event
    Result

civicrm_event_get($params)

Availability: v1.8

This api is used for finding an existing event.
Required parameters : id of event

Parameters:

  • 'params' (array) an associative array of title/value property values of civicrm_event

Returns:

  • Array of all found event property values if successful, error message otheriwse
Get Event By Id
Get Event By Title
Result

civicrm_delete_event( $params )

Availability: v1.8

This API is used for deleting an event

Parameters:

  • 'params' (array) array containing event_id to be deleted

Returns:

  • Success message if successful, error message otherwise
Delete Event
Result

civicrm_event_search($params)

Availability: v1.8

Get event record(s) for given input params

Parameters:

  • 'params' (array) an associative array of title/value property values of civicrm_event
    • As of CiviCRM 3.1, two new parameters are evaluated:
      • $params['return.max_results'] which overrides the default number of maximum events returned
      • $params['return.offset'] which deteremines an off set for returned events. This could be used to create paged results, for example.

Returns:

  • Array of up to 25 maximum ( or $params['return.max_results'] ) found event values if successful, error message otherwise
    Search Events
    Result
Labels
  • None

Creative Commons License
Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-Share Alike 3.0 United States Licence.