Send a message to a set of email addresses.
Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
---|---|---|---|
CRTeamraiserAPI | None. | POST | Yes. |
See topic Common Parameters.
Required. The TeamRaiser event ID.
Type xsd:nonNegativeInteger.
Required. The layout ID.
Type xsd:nonNegativeInteger.
Optional. Message ID.
Type xsd:nonNegativeInteger.
Optional. The name of the message.
Type xsd:string.
Optional. The message ID of the suggested message selected by the participant.
Type xsd:nonNegativeInteger.
Required. The message recipients list.
Type xsd:string.
Required. The message subject.
Type xsd:string.
Optional. The message body.
Type xsd:string.
Optional. Setting to prepend personalized salutation to TAF emails
Type xsd:boolean.
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.
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.
See topic HTTP Status Codes.
XML responsetrueJSON response
{"sendTafMessageResponse":{"success":"true"}}