updateCompanyPageInfo

Updates a company page.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=updateCompanyPageInfo &api_key=value &v=value [ &auth=value ] [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &company_id=value &fr_id=value [ &headline1=value ] [ &headline2=value ] [ &headline3=value ] [ &page_title=value ] [ &rich_text=value ] [ &status1=value ] [ &status2=value ] [ &status3=value ] [ &status4=value ] [ &status5=value ] [ &text1=value ] [ &text2=value ] [ &text3=value ] [ &auth=value ] [ &sso_auth_token=value ]

Usage Notes

This method requires authentication, and must include the company_id. Only the logged-in constituent who is identified as the Company Coordinator in the Company record has permission to execute this method.

The Company Coordinator is defined by the system administrator when the Company record is created.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

company_id

Required. The unique ID of the company.

Type xsd:nonNegativeInteger.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

headline1

Optional. The first headline on the page.

Type xsd:string.

headline2

Optional. The second headline on the page.

Type xsd:string.

headline3

Optional. The third headline on the page.

Type xsd:string.

page_title

Optional. The title of the page

rich_text

Optional. The rich text area of the page.

Type xsd:string.

status1

Optional. Status Indicator 1

Type xsd:string.

status2

Optional. Status Indicator 2

Type xsd:string.

status3

Optional. Status Indicator 3

Type xsd:string.

status4

Optional. Status Indicator 4

Type xsd:string.

status5

Optional. Status Indicator 5

Type xsd:string.

text1

Optional. The first text area on the page.

Type xsd:string.

text2

Optional. The second text area on the page.

Type xsd:string.

text3

Optional. The third text area on the page.

Type xsd:string.

auth

Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Convio web page.

sso_auth_token

Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<updateCompanyPageResponse 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>
</updateCompanyPageResponse>

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

        

Leave a Comment

Nickname
Comment
Enter this word: