updateRegionalCompany

Updates an existing regional company.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
None. SRTeamraiserAPI POST No.

Server API Syntax

https://secure2.convio.net/organization/site/SRTeamraiserAPI?method=updateRegionalCompany & 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 ] & fr_id =value [ & company_name =value ] & company_id =value [ & company_fundraising_goal =value ] [ & company_coordinator_cons_id =value ] [ & classification =value ] [ & company_coordinator_gift_recording =true |false ] [ & fr_ids =value ] [ & company_coordinator_gift_recording =true |false ] [ & fiscal_year =value ]

Usage Notes

Updating large amounts of data can impact performance. Schedule large data updates during non-peak hours. Additionally, run the APIs one at a time.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

company_name

Optional. The public name of the company.

Type xsd:string.

company_id

Required. The id of the company.

Type xsd:nonNegativeInteger.

company_fundraising_goal

Optional. The company's fundraising goal

Type xsd:nonNegativeInteger.

company_coordinator_cons_id

Optional. The constituent ID of the company coordinator

Type xsd:nonNegativeInteger.

classification

Optional. The primary event type the company will be associated with.

Type xsd:string.

company_coordinator_gift_recording

Optional. Can the company coordinator record gifts

Type xsd:boolean.

Options are:
  • true
  • false
fr_ids

Optional. A comma-separated list of event IDs the regional company is associated with

Type xsd:string.

company_coordinator_gift_recording

Optional. Can the company coordinator record gifts

Type xsd:boolean.

Options are:
  • true
  • false
fiscal_year

Optional. The fiscal year of the regional company.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response



<?xml version="1.0" encoding="UTF-8"?>
<updateRegionalCompanyResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <success>true</success>
</updateRegionalCompanyResponse>



        
JSON response
{"updateRegionalCompanyResponse":{"success":"true"}}

        

Examples

Note: Escape or enclose code in a CDATA block -->

Leave a Comment

Nickname
Comment
Enter this word: