The Create Event service will accept form-encoded data representing a new event and create a new event in the Pushpay system. The service returns the profile of the event that was created.
Service Name
create_event
Required Parameters
| Name | Type | Description |
|---|---|---|
| group_id | integer | Must be sent via HTTP POST |
| start_date | datetime | Must be sent via HTTP POST |
| end_date | datetime | Must be sent via HTTP POST |
| name | string | Must be sent via HTTP POST |
Optional Parameters
| Name | Type | Description |
|---|---|---|
| description | string | Must be sent via HTTP POST |
| leader_notes | string | Must be sent via HTTP POST |
| setup_minutes | integer | Must be sent via HTTP POST |
| cleanup_minutes | integer | Must be sent via HTTP POST |
| setup_notes | string | Must be sent via HTTP POST |
| organizer_id | integer | Must be sent via HTTP POST |
| contact_phone | string | Must be sent via HTTP POST |
| event_type_id | integer | Must be sent via HTTP POST |
| registration_form_id | integer | Must be sent via HTTP POST |
| event_grouping_id | integer | Must be sent via HTTP POST |
| registration_limit | integer | Must be sent via HTTP POST |
| recurrence_type | string | Must be sent via HTTP POST Must be one of the following: 'daily'; 'weekly'; 'monthly' |
| recurrence_frequency | integer | Must be sent via HTTP POST Must be greater than zero |
| recurrence_week_number | string | Must be sent via HTTP POST Must be one of the following: 'first'; 'second'; 'third'; 'fourth'; 'last' |
| recurrence_day_of_week | string | Must be sent via HTTP POST Must be one of the following: 'mon'; 'tue'; 'wed'; 'thu'; 'fri'; 'sat'; 'sun' |
| recurrence_day_of_month | integer | Must be sent via HTTP POST Must be between 0 and 31. |
| recurrence_end_date | datetime | Must be sent via HTTP POST |
| number_of_occurrences | integer | Must be sent via HTTP POST |
| location_name | integer | Must be sent via HTTP POST |
| location_street_address | integer | Must be sent via HTTP POST |
| location_city | integer | Must be sent via HTTP POST |
| location_state | string | Must be sent via HTTP POST Must be two or three uppercase characters |
| location_zip | integer | Must be sent via HTTP POST |
| notification | boolean | Must be sent via HTTP POST |
| attendance_reminder | boolean | Must be sent via HTTP POST |
| uses_resources | boolean | Must be sent via HTTP POST |
| use_campus_address | boolean | Must be sent via HTTP POST |
| listed | boolean | Must be sent via HTTP POST |
| creator_id | integer | Must be sent via HTTP POST |
Example Curl
curl -u user:pass -d "name=Test+Event+via+API&start_date=2012-09-27+09:00:00&end_date=2012-09-27+11:30:00&group_id=1&recurrence_type=monthly&recurrence_week_number=second&recurrence_day_of_week=tue" "https://yourchurch.ccbchurch.com/api.php?srv=create_event"Example Response XML
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
<request>
<parameters>
<argument value="create_event" name="srv"/>
</parameters>
</request>
<response>
<service>create_event</service>
<service_action>execute</service_action>
<availability>public</availability>
<event id="12">
<name>Test Event via API</name>
<description></description>
<leader_notes></leader_notes>
<start_datetime>2012-09-27 09:00:00</start_datetime>
<start_date>Sep 27, 2012</start_date>
<start_time>9:00 AM</start_time>
<end_datetime>2012-09-27 11:30:00</end_datetime>
<end_date>Sep 27, 2012</end_date>
<end_time>11:30 AM</end_time>
<timezone>America/Denver</timezone>
<recurrence_description>Every month on the second Tuesday of the month from 9:00 AM to 11:30 AM</recurrence_description>
<exceptions/>
<group id="1">Entire Church Group</group>
<organizer id="1">Larry Cucumber</organizer>
<phone type="mobile"></phone>
<location/>
<registration>
<limit>0</limit>
<event_type id="1">Open to All</event_type>
<forms/>
</registration>
<resources/>
<setup>
<start>2012-09-27 09:00:00</start>
<end>2012-09-27 11:30:00</end>
<notes></notes>
</setup>
<event_grouping id=""></event_grouping>
<creator id="0">System User</creator>
<modifier id="0">System User</modifier>
<created>2014-01-28 14:17:50</created>
<modified>2014-01-28 14:17:50</modified>
</event>
</response>
</ccb_api>