To create or update a recipient in your Higher Logic Thrive Marketing Enterprise (Thrive Marketing Enterprise) account, follow the steps below. This call is for individuals who may or may not already exist in Thrive Marketing Enterprise by the account’s Unique Identifier (Email or Custom ID).

NOTE: To determine this setting, log in to Thrive Marketing Enterprise and navigate to Settings.

Example

Upsert recipient:

{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"RecipientDetails":{
"Address":"String content",
"Address2":"String content",
"City":"String content",
"Company":"String content",
"CustomFields":[{
"Key":2147483647,
"Value":"String content"
}],
"CustomMemberID":"String content",
"Email":"test@higherlogic.com",
"EnhancedPersonalizedFields":[{
"Key":2147483647,
"Value":"String content"
}],
"Fax":"String content",
"FirstName":"String content",
"ID":9223372036854775807,
"LastName":"String content",
"Phone":"String content",
"RecipientSuppressed":true,
"SmsNumber":"String content",
"State":"String content",
"TextOnly":true,
"Unsubscribed":true,
"Zip":"String content"
},
"UpdateWithNullifNotPassed":true,
"UpsertType":"String content",
"ValidateEmail":true
}

HTTP POST

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

POST Parameters

Required Parameters

Parameter	Value	Description
SessionID	String	An authentication token which can be obtained by making the authenticate call.
UserID	String	The user ID returned in the authenticate call.
Email	String	The email address of the recipient you would like to create.
UpsertType	String	The type of upsert: Edit (default) Add
ValidateEmail	Boolean	Determines whether this call will use Thrive Marketing Enterprise's validation process for the email address. NOTE: It's recommended that this is set to True to avoid inserting erroneous addresses.

Conditional Parameters

The parameter below may be required under certain conditions.

NOTE: If your account has custom ID as the unique identifier, the parameter below is required.

Parameter	Value	Description
CustomMemberID	String	This would have to be a unique ID for the account. If your organization uses an AMS or CRM, this ID is generally provided by that system.

Optional Parameters

These parameters are not required under any condition. You can include any of the following parameters to add information to the recipient record.

NOTE: After the recipient is created, you can edit the record with EditRecipient/.

Parameter	Value	Description
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.
CustomFields	Array	A range of custom fields created via the User Interface and used for personalization. To get a list of custom fields for the account please see the GetRecipientFields/ call. For the call, the Key must reflect the key name returned for GetRecipientFields/ (e.g., Key:2, is Custom Field 2).
EnhancedPersonalizedFields	Array	A range of custom fields created via the User Interface and used for personalization. To get a list of custom fields for the account please see the GetRecipientFields/ call. For the call, the Key must reflect the key name returned for GetRecipientFields/ (e.g., Key:2, is Custom Field 2).
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.
ID	Int	This is the Recipient ID of the record. If editing, this field can be used to match.
Phone	String	The phone number for the recipient record.
State	String	The state name for the recipient record.
TextOnlyRecipient	Boolean	Whether recipient has opted to only receive 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 Thrive Marketing Enterprise 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.
RecipientSuppressed	Boolean	Determines whether the recipient will be marked as a manual suppression. If true, the recipient will no longer receive any emails from Thrive Marketing Enterprise. This field must be placed within the recipient details bracket to be used as intended; if it's not, it will not suppress a recipient as desired. NOTE: If this field is not included in the call, it will default to false for that recipient record. If not included and the recipient is currently suppressed, it will change the suppression status to false with the exception of Spam Complaints. NOTE: If the UpdateWithNullIfNotPassed is set to false and the RecipientSuppressed field is left out of the call, then the suppression status will not be changed.
UpdateWithNullifNotPassed	Boolean	When set to false, values that are not passed are not updated. If a variable is not included in the call and this is set to true, variables that are not passed are set to NULL. NOTE: Pay close attention to flags like Unsubscribe, Suppressed, and Send Text Only. NOTE: The exception here is with Custom Fields and Standard Fields. The custom fields will NOT be nulled out if this is set to true and the fields are not passed. The enhanced fields WILL be nulled out if this is set to true and the fields are not passed in the call.
SmsNumber	String	If SMS is enabled for the account, this is the SMS number.
Unsubscribed	Boolean	Whether to unsubscribe the recipient from All.