API Summary Overview - Action Requests

An action request is the way an application invokes Informz to perform a specific 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 if the action was successful or not. Error handling can be developed based on these responses.

Below are several examples of action requests.

Subscribers

This request supports the transfer of email address and related personal information (referred to as personalization fields in Informz) for people in your system to become subscribers in Informz. There is one apporach for transferring 1,000 or fewer records and one for larger groups of records. All upload activity is viewable int he Informz UI.

Subscribe

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

Parameters:

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 Informz.
Values Data for each field.

 BulkUpload

This request provides a way to import over 1,000 records with email addresses and personal information. This is performed synchronously.

Parameters:

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 Informz.
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 Informz).

Parameters:

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 Informz.

Parameters:

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

Mailings

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

CreateMailing

This request passes your HTML And related information into a mailing in Informz. Once created, it can be viewed, edited, copied, or deleted in the Informz UI.

Parameters:

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 Informz template to be used for this mailing.
Format HTML or Text.
Story(ies) A block of HTML content withint he mailing.
Title The title for a particular story.

Schedule Mailing

This request provides a way to schedule an existing mailing to be est from Informz.

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 Informz.
Values Data for each field.
AccountingCode Code used for internal accounting or categorization.