An action request is how an application invokes Higher Logic Thrive Marketing Professional (Thrive Marketing Professional) to perform an action or task. Currently, these actions surround transferring email address information and working with mailings.

Every action request has a corresponding response. The response message indicates whether the action was successful. Error handling can be developed based on these responses. Below are several examples of action requests.

Header tags

Every Action Request contains the information shown in the example.

The <Brand id> tag corresponds to a Thrive Marketing Professional brand (account). The ID attribute must match the brand's ID in order to be permitted in through the web service.
The <User> tag corresponds to a valid Thrive Marketing Professional user.

<Brand id="9999">Test Brand</Brand>
<User>testuser</User>
<Password>password</Password>

Subscribers

This request supports the transfer of email address and related personal information (personalization fields in Thrive Marketing Professional) for people in your system to become subscribers in Thrive Marketing Professional. There is one approach for transferring 1,000 or fewer records and one for larger groups of records. All upload activity is viewable in the Thrive Marketing Professional interface.

Use this request to import up to 1,000 records with email addresses and personal information (e.g., First Name, Last Name, etc.). This is performed synchronously.

Name	Description
Email Address	Any valid email address that has opted-in
ID	A unique ID from your application
Interest Name(s)	The name of the "list(s)" that the email is affiliated with
AddOrUpdateSubscribers	Insert a new subscriber or update an existing subscriber if one exists
ReplaceAllSubscribers	A way to "empty" an interest to perform a clean upload
Fields	Associated data such as "First Name" or "Title" that can be uploaded into Thrive Marketing Professional
Values	Data for each field

BulkUpload

Use this request to import over 1,000 records with email addresses and personal information. This is performed synchronously.

Name	Description
Email Address	Any valid email address that has opted-in
ID	A unique ID from your application
Interest Name(s)	The name of the "list(s)" that the email is affiliated with
AddOrUpdateSubscribers	Insert a new subscriber or update an existing subscriber if one exists
ReplaceAllSubscribers	A way to "empty" an interest to perform a clean upload
RemoveSubscribers	A way to "empty" an interest without performing a new upload
Fields	Associated data such as "First Name" or "Title" that can be uploaded into Thrive Marketing Professional
Values	Data for each field

OptOut

This request provides a way to opt out a subscriber from a specific list (referred to as an interest in Thrive Marketing Professional).

Name	Description
Email Address	Any valid email address that has opted-in
ID	A unique ID from your application
Interest Name(s)	The name of the "list(s)" that the email is affiliated with

Unsubscribe

This request sets a subscriber to the unsubscribed status. This prevents the subscriber(s) from receiving any further mailings from Thrive Marketing Professional.

Name	Description
Email Address	Any valid email address that has opted-in
ID	A unique ID from your application

Mailings

Using Thrive Marketing Professional to send and deliver your mailings is a great way to leverage our established technologies and support processes to add the quality of service that your clients expect. You can use the Informz API to create mailings in Thrive Marketing Professional using HTML created in your application, or you can use Thrive Marketing Professional's email creation, editing, reviewing, and testing tools directly and then simply call Thrive Marketing Professional to send the existing mailing.

Create Mailing

This request passes your HTML and related information into a mailing in Thrive Marketing Professional. Once created, it can be viewed, edited, copied, or deleted in the Thrive Marketing Professional interface.

Name	Description
Name	The mailing name
Folder	The folder name
FriendlyFrom	A descriptive string about the sender (e.g., "Member Services")
EmailFrom	Email address of the sender
ReplyTo	Email address for any direct replies
Subject	The subject line; this can be personalized
TemplateID	The corresponding Thrive Marketing Professional template to be used for this mailing
Format	HTML or Text
Story(ies)	A block of HTML content within the mailing
Title	The title of a story

Schedule Mailing

This request provides a way to schedule an existing mailing.

Name	Description
MailingID	The ID of the mailing to be scheduled
PublishDateTime	When the mailing is scheduled to be sent
TargetGroup	The name of the interest (list) to be used
TestMessage	Determines whether this is a test message or not
Emails	Individual email addresses to be used
Fields	Associated names like "First Name" or "Title" that can be uploaded into Thrive Marketing Professional
Values	Data for each field
AccountingCode	Code used for internal accounting or categorization

Create Message

This request passes your HTML and related information into a Mailing Designer 2 message in Thrive Marketing Professional. Once created, it can be viewed, edited, copied, or deleted in the Thrive Marketing Professional interface.

Name	Description
Name	The message name
Folder	The folder name
FriendlyFrom	A descriptive string about the sender (e.g., "Member Services")
EmailFrom	Email address of the sender
ReplyTo	Email address for any direct replies
Subject	The subject line; this can be personalized
TemplateID	The corresponding Thrive Marketing Professional template to be used for this mailing
HTMLContent	The mailing content to be sent to recipients
MessageContentArea	Unique name of the message content area
MessageStories	A block of HTML content within the mailing
TextOnlyContent	The text version of the mailing content. If not provided, Thrive Marketing Professional will generate its own text version from the supplied HTML content
Title	The title of a story

Action Requests