The joinTeam API is used by a participant to join an existing TeamRaiser team for a given event.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRTeamraiserAPI | None. | POST | Yes |
The joinTeam method makes a participant who is registered for a TeamRaiser event as an individual a member of the specified team. To change a participant's team membership from one team to another, first call leaveTeam for the participant's current team, then joinTeam for the new team.
Use authentication to ensure team members are successfully added to a team.
See topic Common Parameters.
Required. The TeamRaiser event ID.
Type xsd:nonNegativeInteger.
Required. A unique team ID.
Type xsd:nonNegativeInteger.
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 Luminate Online web page.
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.
Optional. Team password.
Type xsd:string.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<joinTeamResponse xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<success xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd">true</success>
<team>
<name>Example Team</name>
<description>Example team description</description>
<captainsMessage>Example captains message</captainsMessage>
<goal>1000</goal>
<id>10000</id>
</team>
</joinTeamResponse>
JSON response
{"joinTeamResponse":{"team":{"id":"10000","description":"Example team description","name":"Example Team","captainsMessage":"Example captains message","goal":"1000"},"success":{"content":"true"}}}