The Update Group service will accept form-encoded data representing an existing group and update the group in the Pushpay system. The service returns the profile of the updated group.
Service Name
update_group
Required Parameters
| Name | Type |
|---|---|
| id | integer |
Optional Parameters
| Name | Type | Description |
|---|---|---|
| name | string | Must be sent via HTTP POST |
| description | string | Must be sent via HTTP POST |
| campus_id | integer | Must be sent via HTTP POST |
| group_type_id | integer | Must be sent via HTTP POST |
| department_id | integer | Must be sent via HTTP POST |
| area_id | integer | Must be sent via HTTP POST |
| group_capacity | integer | Must be sent via HTTP POST |
| meeting_location_street_address | string | Must be sent via HTTP POST |
| meeting_location_city | string | Must be sent via HTTP POST |
| meeting_location_state | string[2–3] | Must be sent via HTTP POST Must be two or three uppercase characters |
| meeting_location_zip | string | Must be sent via HTTP POST |
| meeting_day_id | integer | Must be sent via HTTP POST |
| meeting_time_id | integer | Must be sent via HTTP POST |
| childcare_provided | boolean | Must be sent via HTTP POST |
| interaction_type | string | Must be sent via HTTP POST Must be one of the following: 'Announcement Only'; 'Members Interact'; 'Administrative' |
| membership_type | string | Must be sent via HTTP POST Must be one of the following: 'Open to All'; 'Invitation Required'; 'Request Required' |
| notification | boolean | Must be sent via HTTP POST |
| listed | boolean | Must be sent via HTTP POST |
| public_search_listed | boolean | Must be sent via HTTP POST |
| udf_group_pulldown_1_id | integer | Must be sent via HTTP POST |
| udf_group_pulldown_2_id | integer | Must be sent via HTTP POST |
| udf_group_pulldown_3_id | integer | Must be sent via HTTP POST |
| inactive | boolean | Must be sent via HTTP POST |
| modifier_id | integer | Must be sent via HTTP POST |
| main_leader_id | integer | Must be sent via HTTP POST |
| director_id | integer | Must be sent via HTTP POST |
| coach_id | integer | Must be sent via HTTP POST |
Example Curl
curl -u user:pass -d "group_capacity=10¬ification=true" "https://yourchurch.ccbchurch.com/api.php?srv=update_group&id=470"Example Response XML
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
<request>
<parameters>
<argument value="update_group" name="srv"/>
<argument value="23" name="id"/>
</parameters>
</request>
<response>
<service>update_group</service>
<service_action>execute</service_action>
<availability>public</availability>
<groups count="1">
<group id="23">
<name>**Ninja Turtle Club**</name>
<description>Fight by night</description>
<image></image>
<campus id="1">Church of Cucumbers</campus>
<main_leader id="49">
<first_name>Group</first_name>
<last_name>Leader</last_name>
<full_name>Group Leader</full_name>
<email>[email protected]</email>
<phones>
<phone type="mobile"></phone>
</phones>
</main_leader>
<leaders>
<leader id="34">
<first_name>Assistant</first_name>
<last_name>Group Leader</last_name>
<full_name>Assistant Group Leader</full_name>
<email>[email protected]</email>
<phones>
<phone type="mobile"></phone>
</phones>
</leader>
</leaders>
<participants/>
<group_type id="1">Care / Small Group</group_type>
<department id="0"></department>
<area id="0"></area>
<calendar_feed>webcal://yourchurch.ccbchurch.com/group_calendar.ics?id=23&tk=ABC123</calendar_feed>
<registration_forms/>
<current_members>9</current_members>
<group_capacity>Unlimited</group_capacity>
<addresses/>
<meeting_day id="0"></meeting_day>
<meeting_time id="0"></meeting_time>
<childcare_provided>false</childcare_provided>
<interaction_type>Members Interact</interaction_type>
<membership_type>Invitation or Request Required</membership_type>
<notification>false</notification>
<user_defined_fields/>
<listed>true</listed>
<public_search_listed>false</public_search_listed>
<inactive>false</inactive>
<creator id="1">Larry Cucumber</creator>
<modifier id="1">Larry Cucumber</modifier>
<created>2012-09-20 08:51:01</created>
<modified>2012-10-05 16:34:47</modified>
</group>
</groups>
</response>
</ccb_api>