mergeOrganizations

Merges two organizations and returns the final, combined record

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
None. SROrganizationAPI POST Yes.

Server API Syntax

https://secure2.convio.net/organization/site/SROrganizationAPI?method=mergeOrganizations & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & master_org_id =value & duplicate_org_id =value [ & primary_address_id =value ] [ & mailing_address_id =value ] [ & master_phone_number_id =value ] & organization =value

Usage Notes

Fields to explicitly modify on the merged record are passed url-encoded as the value of the organization parameter in the following format:

            
              <organizationRequest xmlns="http://convio.com/crm/v1.0">
                  <organization>
                      <name>Apple</name>
                      <url>http://www.apple.com</url>
                      <category_id>0</category_id>
                      <num_employees>100000</num_employees>
                  </organization>
              </organizationRequest>

    
    

Fields not included as part of the organization parameter are left unchanged from the master record.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

master_org_id

Required. Org ID for the master record

Type xsd:int.

duplicate_org_id

Required. Org ID for the duplicate record. This record will be marked as deleted after the merge.

Type xsd:int.

primary_address_id

Optional. Master primary address ID

Type xsd:int.

mailing_address_id

Optional. Master mailing address ID

Type xsd:int.

master_phone_number_id

Optional. Master phone number ID

Type xsd:int.

organization

Required. The XML document containing the data for the organization.

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<getOrganizationResponse xmlns="http://convio.com/crm/v1.0">
    <organization>
        <org_id>100</org_id>
        <name>Test Organization</name>
        <url>http://sample.url</url>
        <category_id>5</category_id>
        <num_employees>10</num_employees>
        <address>
            <address_id>620</address_id>
            <address_type_id>1</address_type_id>
            <org_id>100</org_id>
            <street1>123 Any Street</street1>
            <city>Austin</city>
            <state_province>TX</state_province>
            <postal_code>78758</postal_code>
            <country>United States</country>
        </address>
        <phone_number>
            <phone_number_id>550</phone_number_id>
            <org_id>100</org_id>
            <number>5125551234</number>
            <extension>1234</extension>
        </phone_number>
    </organization>
</getOrganizationResponse>


        
JSON response
{"getOrganizationResponse":{"organization":{"org_id":"100","phone_number":{"extension":"1234","org_id":"100","phone_number_id":"550","number":"5125551234"},"address":{"org_id":"100","street1":"123 Any Street","state_province":"TX","address_id":"620","postal_code":"78758","address_type_id":"1","country":"United States","city":"Austin"},"name":"Test Organization","category_id":"5","url":"http://sample.url","num_employees":"10"}}}

        

Leave a Comment

Nickname
Comment
Enter this word: