The Real Magnet REST API allows you to query your account for recipient data, message content, and groups.  Continually, the Real Magnet REST API gives users the ability to create and send messages, manage recipient details, and retrieve tracking metrics.

This guide provides a list of calls, their definition as well as their required parameters.  The order of the calls in this guide is typically the order in which you may generate calls to the REST API.  

Prerequisites

Before attempting to use the REST API,  you should understand some of the general rules of Real Magnet recipient data and how that data is used when designing, sending and analyzing the results of Real Magnet messages. The following is an overview of some of these concepts, which will influence your understanding of the API.

One of the recommendations of this documentation is that you log in to the Real Magnet system, or utilize the documentation found throughout the realmagnethelp.com to have a basic understanding of using Real Magnet.

Authentication

Base URL

All REST calls will reference the following base URL:

https://dna.magnetmail.net/ApiAdapter/Rest/

The Real Magnet REST API is served over HTTPS. It is recommended that calls be supplied via HTTPS for security purposes.  

Authenticate/

To authenticate use the call: https://dna.magnetmail.net/ApiAdapter/Rest/Authenticate/

HTTP requests to the REST API are protected with HTTP Basic authentication. You will use your Real Magnet credentials for the Username and Password. If you do not have API credentials please contact customer support.

The REST header will return the following:

{
"LoginID":"1234567",
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE"
}

Character Restrictions

 Additional Information

Header Settings

Additional settings for the header can be found here if you would like to ensure that your response is in JSON for example, you’ll want to include Accept: application/json

Methods

Endpoint Method Description
Authenticate/
POST Retrieves the LoginID, SessionID and UserID.
AddRecipient/
POST Adds a new Recipient to Real Magnet based on account Unique Identifier.
AddGroup/
POST Creates a new Group in Real Magnet.
CreateDynamicContentBlock/ POST Creates a Dynamic Content Block.
CreateDynamicContentElement/ POST Creates a Dynamic Content Element.
CreateMessage/ 
POST Creates a Real Magnet Message.
EditDynamicContentElement/ POST Edits an existing Dynamic Content Element.
EditMessage/ POST Edits an existing Real Magnet Message.
EditRecipient/
POST Edits an existing Real Magnet Recipient.
EditRecipientGroups/
POST Edits an existing Real Magnet Group, to either unsubscribe a recipient from a group or to add them.
ExecuteReport/
POST Retrieves data from custom queries built into the Real Magnet REST service.
GetDetailedTracking/
POST Retrieves tracking information for a message.
GetDynamicContentBlocks/ POST Retrieves existing Dynamic Content Blocks.
GetDynamicContentElementDetails/ POST Retrieves existing Dynamic Content Element details – this would include the recipient details the element is looking for.
GetDynamicContentElements/ POST Retrieves existing Dynamic Content Elements.
GetGroupCategories/
POST Retrieves Group Categories.
GetGroupDetails/
POST Retrieves existing Group details, including total unsubscribed, suppressed and creation details.
GetGroupRecipients/
POST Retrieves a paginated list of recipients from an existing group.
GetGroups/
POST Retrieves a list of existing Groups.
GetMessageCategory/
POST Retrieves a list of existing Message Categories.
GetMessageDetails/
POST Retrieves existing Message details, including creation information.
GetMessageLinkTracking/
POST Retrieves the link tracking for an already deployed Message.
GetMessageList/
POST Retrieves a list of Messages deployed as well as the Groups they were sent to.
GetRecipientFields/
POST Retrieves a list of Recipient fields, including the field name and content.
GetRecipientGroups/
POST Retrieves a list of Groups a Recipient is currently in.
GetRecipientHistory/ POST Retrieves a list of the Recipient’s Real Magnet activity.
GetReportMetaData/
POST Returns the required fields for a request to ExecuteReport/ method.
GetReports/
POST Returns the different reporting options currently available.
GetSubscribers/ POST Retrieves a list of subscribed recipients via an SMP or API calls
(SubscribeRecipient/ UnsubscribeRecipient/) within a range of dates.
GetSuppressedRecipients/ POST Retrieves a list of suppressed individuals by Group.
GetUnsubscribes/ POST Retrieves a list of unsubscribed recipients within a range of dates.
GetUploadStatus/ POST Retrieves the upload status of a group, if completed will return the number of accepted records.
SearchRecipient/
POST Searches for a list of recipients using different criteria such as First Name or Email etc.
SendEmailToGroup/
POST Sends a message with both an html and text version to a group of recipients.
SendEmailToGroupWithProfile/
POST Sends a message with both an html and text version from a specific Sending Profile to a group of recipients.
SendEmailToIndividual/
POST Send a message to an individual recipient.
SubscribeRecipient/
POST Subscribes a recipient to either a group or a category.
UnsubscribeRecipient/
POST Unsubscribes a recipient to either a group or a category.
UploadRecipients/
POST Uploads recipients to a group.
UpsertRecipient/
POST Adds or edits a recipient with Enhanced Personalized Fields.