NOTE: This article references "Real Magnet" -- a previous name of the Higher Logic Communications Enterprise product.
To create a new recipient in your Real Magnet account, follow the steps below. This call is only for individuals who do not already exist in Real Magnet by the account's Unique Identifier (Email or Custom ID). See Considerations Before Uploading Records with Custom ID as the Unique Identifier to learn more.
To determine this setting, log in to Real Magnet and navigate to Tools.
Create a recipient if the email address is your Unique Identifier:
The following parameters are required in your POST to create the recipient:
|SessionID||String||This is an authentication token which can be obtained by making the authenticate call.|
|UserID||String||The UserID returned in the authenticate call.|
|String||The recipient email address of the recipient you would like to create.|
You may also include the following parameter (that may be required under certain conditions).
WARNING: If your account has CUSTOM ID as the unique identifier, this parameter is required.
|CustomID||String||This needs to be a unique ID for the account. If there is an AMS or CRM, this ID is typically provided by that system. If the account has Custom Member ID as the Unique ID, this value is required.|
These parameters are optional, and are not required under any condition. You can include any of the following parameters to add information to the recipient record.
NOTE: Once the recipient is created, you can edit the record with EditRecipient/.
|Address||String||The address field for the recipient record (e.g., 4853 Cordell Ave).|
|Address2||String||The additional address for the recipient record, for example, a suite number.|
|City||String||The city for the recipient record.|
|Company||String||The company name for the recipient record.|
|CustomField1—30||String||A range of custom fields created via the User Interface and used for personalization. To get a list of custom fields for the account, see the GetRecipientFields/ call.|
|Groups||Int||The group you would like to add the recipient to. To get a list of group IDs, see the GetGroups/ call.|
|Fax||String||The fax number for the recipient record.|
|FirstName||String||The first name for the recipient record.|
|LastName||String||The last name for the recipient record.|
|Phone||String||The phone number for the recipient record.|
|State||String||The state name for the recipient record.|
Whether recipient has opted to receive only the text version of an email message.
NOTE: If this field is not included in the call, it will default to FALSE for that recipient record.
EXAMPLE: Setting this to TRUE checked the "Text Only" box in the Real Magnet system. Now, this record will receive only the text version of an email message.
|Zip||String||The zip or postal code field for the recipient. Keep in mind that for zip code locator, this will only process with the 5-digit zip code.|