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.

org_id

Required. Org ID

Type xsd:int.

company_name

Required. The public name of the company.

Type xsd:string.

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

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

Type xsd:string.

fiscal_year

Optional. The fiscal year of the regional company.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<getNationalCompanyResponse 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">
  <company>
    <orgId>1000</orgId>
    <publicName>sampleCompany</publicName>
    <companyFundraisingGoal>4000</companyFundraisingGoal>
    <classificationId>1</classificationId>
    <classification>Type 1</classification>
    <securityCategoryId>12</securityCategoryId>
    <companyCoordinatorGiftRecording>true</companyCoordinatorGiftRecording>
    <companyCoordinatorConsId>1000</companyCoordinatorConsId>
  </company>
</getNationalCompanyResponse>





        

{"addRegionalCompanyResponse":{"companyId":"1000"}}