The Create Individual service will accept form-encoded data representing a new individual and create a new individual (and family, if needed) in the Pushpay system. The service returns the new profile of the individual that was created.
Service Name
create_individual
Required Parameters
None
Optional Parameters
| Name | Type | Description |
|---|---|---|
| first_name | string | Must be sent via HTTP POST |
| last_name | string | Must be sent via HTTP POST |
| middle_name | string | Must be sent via HTTP POST |
| legal_first_name | string | Must be sent via HTTP POST |
| sync_id | integer | Must be sent via HTTP POST |
| other_id | string | Must be sent via HTTP POST |
| salutation | string | Must be sent via HTTP POST |
| suffix | string | Must be sent via HTTP POST |
| campus_id | integer | Must be sent via HTTP POST |
| family_id | integer | Must be sent via HTTP POST |
| family_position | string | Must be sent via HTTP POST Must be one of the following: 'h'; 's'; 'c'; 'o', indicating 'head of household', 'spouse', 'child', or 'other' |
| marital_status | string | Must be sent via HTTP POST Must be one of the following: 's'; 'm'; 'w'; 'd'; 'p'; ' ', indicating 'single', 'married', 'widowed', 'divorced', 'separated', or 'not selected' |
| gender | string | Must be sent via HTTP POST Must be either 'M' or 'F', indicating either Male or Female |
| birthday | datetime | Must be sent via HTTP POST |
| anniversary | datetime | Must be sent via HTTP POST |
| deceased | datetime | Must be sent via HTTP POST |
| limited_access_user | integer | Must be sent via HTTP POST Must be either 1 or 0, indicating either true or false. If not provided, the Campus Privacy Defaults setting will be used. |
| membership_date | datetime | Must be sent via HTTP POST |
| membership_end | datetime | Must be sent via HTTP POST |
| membership_type_id | integer | Must be sent via HTTP POST |
| giving_number | string | Must be sent via HTTP POST |
| string | Must be sent via HTTP POST Must be a valid email | |
| mailing_street_address | string | Must be sent via HTTP POST |
| mailing_city | string | Must be sent via HTTP POST |
| mailing_state | string | Must be sent via HTTP POST Must be two or three uppercase characters |
| mailing_zip | string | Must be sent via HTTP POST |
| mailing_country | string | Must be sent via HTTP POST Must be two uppercase characters |
| home_street_address | string | Must be sent via HTTP POST |
| home_city | string | Must be sent via HTTP POST |
| home_state | string | Must be sent via HTTP POST Must be two or three uppercase characters |
| home_zip | string | Must be sent via HTTP POST |
| home_country | string | Must be sent via HTTP POST Must be two uppercase characters |
| work_street_address | string | Must be sent via HTTP POST |
| work_city | string | Must be sent via HTTP POST |
| work_state | string | Must be sent via HTTP POST Must be two or three uppercase characters |
| work_zip | string | Must be sent via HTTP POST |
| work_country | string | Must be sent via HTTP POST Must be two uppercase characters |
| work_title | string | Must be sent via HTTP POST |
| other_street_address | string | Must be sent via HTTP POST |
| other_city | string | Must be sent via HTTP POST |
| other_state | string | Must be sent via HTTP POST Must be two or three uppercase characters |
| other_zip | string | Must be sent via HTTP POST |
| other_country | string | Must be sent via HTTP POST Must be two uppercase characters |
| contact_phone | string | *DEPRECATED If you pass contact_phone and do not pass mobile_phone, it will populate the mobile_phone. If you pass both, contact_number will be ignored. Must be sent via HTTP POST |
| home_phone | string | Must be sent via HTTP POST |
| work_phone | string | Must be sent via HTTP POST |
| mobile_phone | string | Must be sent via HTTP POST |
| mobile_carrier | int | Must be sent via HTTP POST If not a valid id will be set to zero. Use mobile_carrier_list service to get values. |
| emergency_phone | string | Must be sent via HTTP POST |
| emergency_contact_name | string | Must be sent via HTTP POST |
| allergies | string | Must be sent via HTTP POST |
| confirmed_no_allergies | boolean | Must be sent via HTTP POST |
| baptized | boolean | Must be sent via HTTP POST |
| udftext# | string | # is a number between 1–12 inclusively, Must be sent via HTTP POST |
| udfdate# | datetime | # is a number between 1–6 inclusively, Must be sent via HTTP POST |
| udfpulldown# | integer | # is a number between 1–6 inclusively, Must be sent via HTTP POST |
| creator_id | integer | Must be sent via HTTP POST |
Example Curl
curl -u user:pass -d "first_name=Ken&last_name=Scott&campus_id=0&family_id=0&family_position=c&gender=m&birthday=2%2F12%2F1966&anniversary=May+6%2C+1989&membership_date=2010-01-01&email=ken%40test.net&mailing_street_address=12265+Oracle+Blvd%2C+Suite+105&mailing_city=Colorado+Springs&mailing_state=CO&mailing_zip=80921&mailing_country=US&mobile_phone=719-266-2888" "https://yourchurch.ccbchurch.com/api.php?srv=create_individual"Example Response XML
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
<request>
<parameters>
<argument value="create_individual" name="srv"/>
</parameters>
</request>
<response>
<service>create_individual</service>
<service_action>execute</service_action>
<availability>public</availability>
<individuals count="1">
<individual id="63">
<sync_id></sync_id>
<other_id></other_id>
<giving_number></giving_number>
<campus id="1">Church of Cucumbers</campus>
<family id="49">The Scott Family</family>
<family_image>https://cdn3.ccbchurch.com/preSTABLE/images/group-default.gif</family_image>
<family_position>Primary Contact</family_position>
<family_members/>
<first_name>Ken</first_name>
<last_name>Scott</last_name>
<middle_name></middle_name>
<legal_first_name></legal_first_name>
<full_name>Ken Scott</full_name>
<salutation></salutation>
<suffix></suffix>
<limited_access_user>1</limited_access_user>
<image>https://cdn3.ccbchurch.com/preSTABLE/images/profile-default.gif</image>
<email>[email protected]</email>
<allergies></allergies>
<confirmed_no_allergies>false</confirmed_no_allergies>
<addresses>
<address type="mailing">
<street_address>12265 Oracle Blvd, Suite 105</street_address>
<city>Colorado Springs</city>
<state>CO</state>
<zip>80921</zip>
<country code="US">United States</country>
<line_1>12265 Oracle Blvd, Suite 105</line_1>
<line_2>Colorado Springs, CO 80921</line_2>
<latitude>39.010822</latitude>
<longitude>-104.815760</longitude>
</address>
<address type="home">
<street_address></street_address>
<city></city>
<state></state>
<zip></zip>
<country code=""> </country>
<line_1></line_1>
<line_2></line_2>
</address>
<address type="work">
<street_address></street_address>
<city></city>
<state></state>
<zip></zip>
<country code=""> </country>
<line_1></line_1>
<line_2></line_2>
</address>
<address type="other">
<street_address></street_address>
<city></city>
<state></state>
<zip></zip>
<country code=""> </country>
<line_1></line_1>
<line_2></line_2>
</address>
</addresses>
<phones>
<phone type="home"></phone>
<phone type="work"></phone>
<phone type="mobile"></phone>
</phones>
<mobile_carrier id="0"> </mobile_carrier>
<gender>M</gender>
<marital_status></marital_status>
<birthday>1966-02-12</birthday>
<anniversary></anniversary>
<baptized>false</baptized>
<deceased></deceased>
<membership_type id=""> </membership_type>
<membership_date></membership_date>
<membership_end></membership_end>
<receive_email_from_church>true</receive_email_from_church>
<default_new_group_messages>Group Default</default_new_group_messages>
<default_new_group_comments>Group Default</default_new_group_comments>
<default_new_group_digest>Group Default</default_new_group_digest>
<default_new_group_sms>Never</default_new_group_sms>
<privacy_settings>
<profile_listed>true</profile_listed>
<mailing_address id="2">My Friends</mailing_address>
<home_address id="2">My Friends</home_address>
<home_phone id="3">My Friends and Group Members</home_phone>
<work_phone id="2">My Friends</work_phone>
<mobile_phone id="2">My Friends</mobile_phone>
<emergency_phone id="2">My Friends</emergency_phone>
<birthday id="4">Everyone</birthday>
<anniversary id="4">Everyone</anniversary>
<gender id="4">Everyone</gender>
<marital_status id="2">My Friends</marital_status>
<user_defined_fields id="2">My Friends</user_defined_fields>
<allergies id="1">Church Leadership</allergies>
</privacy_settings>
<active>true</active>
<creator id="0">System User</creator>
<modifier id="0">System User</modifier>
<created>2014-01-28 14:24:17</created>
<modified>2014-01-28 14:24:17</modified>
<user_defined_text_fields/>
<user_defined_date_fields/>
<user_defined_pulldown_fields/>
</individual>
</individuals>
</response>
</ccb_api>