Luminate Online

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=updateCaptainsMessage &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 ] &captains_message=value &fr_id=value [ &auth=value ] [ &sso_auth_token=value ]

Usage Notes

This method requires authentication. The logged-in user must be a Team Captain to execute this method successfully.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

captains_message

Required. The captain's message shown to all team members.

Type xsd:string.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

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"?>
<updateCaptainsMessageResponse 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>
</updateCaptainsMessageResponse>

JSON response

{"updateCaptainsMessageResponse":{"success":"true"}}

updateCaptainsMessage

Client API Syntax

Usage Notes

Client API Parameters

Response

Leave a Comment