sendTafMessage

Send a message to a set of email addresses.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRTeamraiserAPI None. POST Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=sendTafMessage &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 ] &fr_id=value &layout_id=value &recipients=value &subject=value &message_id=value ] [ &message_name=value ] [ &taf_id=value ] [ &message_body=value ] [ &prepend_salutation=value ] [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

layout_id

Required. The layout ID.

Type xsd:nonNegativeInteger.

message_id

Optional. Message ID.

Type xsd:nonNegativeInteger.

message_name

Optional. The name of the message.

Type xsd:string.

taf_id

Optional. The message ID of the suggested message selected by the participant.

Type xsd:nonNegativeInteger.

recipients

Required. The message recipients list.

Type xsd:string.

subject

Required. The message subject.

Type xsd:string.

message_body

Optional. The message body.

Type xsd:string.

prepend_salutation

Optional. Setting to prepend personalized salutation to TAF emails

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 response


  true


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

        

Leave a Comment

Nickname
Comment
Enter this word: