Only use EditRecipient/ to update existing recipient records in Higher Logic Thrive Marketing Enterprise (Thrive Marketing Enterprise). In this call, you can alter any of the standard fields AND the thirty custom fields that can be configured in a Thrive Marketing Enterprise account.

WARNING: This call will delete existing recipient values in Thrive Marketing Enterprise if not used properly. When using this call, be sure to include ALL of a recipient record's values: Those being updated AND those not being updated. Those not included are deleted. For example, a record has 15 values but you only need to update 3. If you only include those 3 values in the call, the other 12 will be deleted.

Example

Edit a recipient record:

{
"LastName":"Record",
"FirstName":"Test",
"Email":"test@higherlogic.com",
"ID":12345678910,
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE"
}

HTTP POST

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

POST parameters

Required parameters

The following parameters are required in your POST to edit the recipient.

Parameter	Value	Description
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.
ID	Int	The recipient ID of the person you want to unsubscribe.

Conditional parameters

You must POST at least one of the following parameters to edit the recipient record.

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.
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 please see the GetRecipientFields/ call.
CustomID	String	The custom ID field associated with the recipient record; this is generally an AMS/CRM individual record ID.
Email	String	The email address for the recipient record.
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.
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.

Optional parameters

These parameters are not required under any condition.

Parameter

Value

Description

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 only receive the text-version of an email message.

EmailSendSuppress

boolean

Whether recipient will be marked as a list upload suppression. If marked true the recipient will no longer receive any emails from Thrive Marketing Enterprise.