Client API Parameters

Common Client Parameters

See topic Common Parameters.

checkin_status

Optional. Your check-in status.

Type xsd:string.

Options are:

• initial
• started
• committed
• paid
• complete
• unknown

emergency_name

Optional. Emergency contact name.

Type xsd:string.

emergency_phone

Optional. Emergency contact phone number.

Type xsd:string.

flow_step

Optional. External application state.

Type xsd:nonNegativeInteger.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

goal

Optional. Your personal fundraising goal, in cents.

Type xsd:string.

private_page

Optional. Whether or not your personal page should be hidden from all searches.

Type xsd:boolean.

receive_gift_notification

Optional. Whether or not you wish to receive gift notifications.

Type xsd:boolean.

anonymous_registration

Optional. Whether or not your registration is to be designated anonymous.

Type xsd:boolean.

company_id

Optional. The id of the company the participant is to be assigned to.

Type xsd:nonNegativeInteger.

company_name

Optional. The name of a new company to be added and assigned to the team.

Type xsd:string.

fb_fundraiser_id

Optional. The id of the Facebook Fundraiser assigned to the participant.

Type xsd:boolean.

screenname

Optional. If specified, your screen name will take the place of your name on public facing pages.

Type xsd:string.

standard_registration

Optional. Whether or not your registration is to be a standard registration.

Type xsd:boolean.

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

        

{"updateRegistrationResponse":{"success":"true"}}