leaveTeam

The leaveTeam method can be used to by a participant to leave a teamraiser team and participate as an indiviual.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRTeamraiserAPI None. POST Yes

Client API Syntax

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

Usage Notes

The leaveTeam method removes a participant from the specified TeamRaiser team so that they may participate in the TeamRaiser event as an individual or join a different team. A team captain can only leave a team if there are no other team members on that team. If the team captain leaves the team, the team is deleted.

Use authentication to ensure the team member is successfully removed from the team. 

Client API Parameters

Common Client Parameters

See topic Common Parameters.

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 loginauthenticateUser, or getSingleSignOnToken.

Response

See topic HTTP Status Codes.

XML response


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


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

        

Leave a Comment

Nickname
Comment
Enter this word: