Update Individual

The Update Individual service will accept form-encoded data representing changes to an existing individual and update the individual in the Pushpay system. The service returns the profile of the individual that was updated.

Service Name

update_individual

Required Parameters

NameType
individual_idinteger

Optional Parameters

NameTypeDescription
first_namestringMust be sent via HTTP POST
last_namestringMust be sent via HTTP POST
middle_namestringMust be sent via HTTP POST
legal_first_namestringMust be sent via HTTP POST
sync_idintegerMust be sent via HTTP POST
other_idstringMust be sent via HTTP POST
salutationstringMust be sent via HTTP POST
suffixstringMust be sent via HTTP POST
campus_idintegerMust be sent via HTTP POST
family_positionstringMust be sent via HTTP POST Must be one of the following: 'h'; 's'; 'c'; 'o', indicating 'head of household', 'spouse', 'child', or 'other'
marital_statusstringMust 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'
genderstringMust be sent via HTTP POST Must be either 'M' or 'F', indicating either Male or Female
birthdaydatetimeMust be sent via HTTP POST
anniversarydatetimeMust be sent via HTTP POST
deceaseddatetimeMust be sent via HTTP POST
membership_datedatetimeMust be sent via HTTP POST
membership_enddatetimeMust be sent via HTTP POST
membership_type_idintegerMust be sent via HTTP POST
giving_numberstringMust be sent via HTTP POST
emailstringMust be sent via HTTP POST Must be a valid email
mailing_street_addressstringMust be sent via HTTP POST
mailing_citystringMust be sent via HTTP POST
mailing_statestringMust be sent via HTTP POST Must be two or three uppercase characters
mailing_zipstringMust be sent via HTTP POST
mailing_countrystringMust be sent via HTTP POST Must be two uppercase characters
home_street_addressstringMust be sent via HTTP POST
home_citystringMust be sent via HTTP POST
home_statestringMust be sent via HTTP POST Must be two or three uppercase characters
home_zipstringMust be sent via HTTP POST
home_countrystringMust be sent via HTTP POST Must be two uppercase characters
work_street_addressstringMust be sent via HTTP POST
work_citystringMust be sent via HTTP POST
work_statestringMust be sent via HTTP POST Must be two or three uppercase characters
work_zipstringMust be sent via HTTP POST
work_countrystringMust be sent via HTTP POST Must be two uppercase characters
work_titlestringMust be sent via HTTP POST
other_street_addressstringMust be sent via HTTP POST
other_citystringMust be sent via HTTP POST
other_statestringMust be sent via HTTP POST Must be two or three uppercase characters
other_zipstringMust be sent via HTTP POST
other_countrystringMust be sent via HTTP POST Must be two uppercase characters
contact_phonestring*DEPRECATED If you pass contact_phone and do not pass mobile_phone and the user does not currently have a mobile_phone set, it will populate the mobile_phone. If you pass both, contact_phone will be ignored. Must be sent via HTTP POST
home_phonestringMust be sent via HTTP POST
work_phonestringMust be sent via HTTP POST
mobile_phonestringMust be sent via HTTP POST
mobile_carrierintMust be sent via HTTP POST If not a valid id will be set to zero. Use mobile_carrier_list service to get values.
emergency_phonestringMust be sent via HTTP POST
emergency_contact_namestringMust be sent via HTTP POST
allergiesstringMust be sent via HTTP POST
confirmed_no_allergiesbooleanMust be sent via HTTP POST
baptizedbooleanMust 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
modifier_idintegerMust be sent via HTTP POST
external_diocesan_idstringMust be sent via HTTP POST

Example Curl

curl -u user:pass -d "first_name=Larry&last_name=Boy&family_position=h&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-555-2888" "https://yourchurch.ccbchurch.com/api.php?srv=update_individual&individual_id=2412"

Example Response XML

<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="update_individual" name="srv"/>
      <argument value="2412" name="individual_id"/>
    </parameters>
  </request>
  <response>
    <service>update_individual</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <individuals count="1">
      <individual id="2412">
        <sync_id></sync_id>
        <other_id></other_id>
        <giving_number></giving_number>
        <campus id="1">Church of Cucumbers</campus>
        <family id="1200">The Boy 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>Larry</first_name>
        <last_name>Boy</last_name>
        <middle_name></middle_name>
        <legal_first_name></legal_first_name>
        <full_name>Larry Boy</full_name>
        <salutation></salutation>
        <suffix></suffix>
        <image>https://cdn3.ccbchurch.com/preSTABLE/images/profile-default.gif</image>
        <login></login>
        <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>38.9517</latitude>
            <longitude>-104.7607</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="mobile">719-555-2888</phone>
          <phone type="home"></phone>
          <phone type="work"></phone>
        </phones>
        <mobile_carrier id="0"> </mobile_carrier>
        <gender>M</gender>
        <marital_status></marital_status>
        <birthday>1966-02-12</birthday>
        <anniversary>1989-05-06</anniversary>
        <baptized>false</baptized>
        <deceased></deceased>
        <membership_type id=""> </membership_type>
        <membership_date>2010-01-01</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="1">Larry Cucumber</creator>
        <modifier id="1">Larry Cucumber</modifier>
        <created>2012-09-25 15:29:15</created>
        <modified>2014-03-15 10:22:33</modified>
        <user_defined_text_fields/>
        <user_defined_date_fields/>
        <user_defined_pulldown_fields/>
      </individual>
    </individuals>
  </response>
</ccb_api>