updateOrganizationDetail

Updates an organization with the details provided in the passed XML document, including the phone number and addresses

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

Server API Syntax

https://secure2.convio.net/organization/site/SROrganizationAPI?method=updateOrganizationDetail & 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 ] & organization =value & org_id =value

Usage Notes

This method replaces organization record to the Luminate Online database. The entire record is replaced, including the address and phone number sub-records. Therefore if the address and phone number are omitted then they will be removed from the database.

Input data is 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>
                <address>
                    <address_type_id>1</address_type_id>
                    <org_id>1</org_id>
                    <street1>1 Infinite Loop</street1>
                    <street2>Suite 500</street2>
                    <city>Cupertino</city>
                    <state_province>CA</state_province>
                    <postal_code>95014</postal_code>
                    <country>United States</country>
                </address>
                <address>
                    <address_type_id>2</address_type_id>
                    <org_id>1</org_id>
                    <street1>PO Box 1234</street1>
                    <city>Cupertino</city>
                    <state_province>CA</state_province>
                    <postal_code>95014</postal_code>
                    <country>United States</country>
                </address>
                <phone_number>
                    <org_id>1</org_id>
                    <number>8006927753</number>
                    <extension>4321</extension>
                </phone_number>
            </organization>
        </organizationRequest>
      
      

Server API Parameters

Common Server Parameters

See topic Common Parameters.

organization

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

Type xsd:string.

org_id

Required. Org ID

Type xsd:int.

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>
    </organization>
</getOrganizationResponse>


        
JSON response
{"getOrganizationResponse":{"organization":{"org_id":"100","name":"Test Organization","category_id":"5","url":"http://sample.url","num_employees":"10"}}}

        

Leave a Comment

Nickname
Comment
Enter this word: