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

Required. Message ID

Type xsd:nonNegativeInteger.

message_name

Required. The name of the message.

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.

recipients

Optional. The message recipients list.

Type xsd:string.

save_template

Optional. Indicates whether or not a message should be considered a permanent template.

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 Luminate Online 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"?>
<addDraftResponse 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">
  <message>
    <subject>example subject</subject>
    <messageBody>example message body</messageBody>
    <messageName>example message name</messageName>
    <layoutId>1234</layoutId>
  </message>
</addDraftResponse>

        

{"addDraftResponse":{"message":{"messageBody":"example message body","subject":"example subject","layoutId":"1234","messageName":"example message name"}}}