An unsubscribe is a recipient-triggered action. In Higher Logic Thrive Marketing Enterprise (Thrive Marketing Enterprise), unsubscribes are either by category or group, but users can also be flagged as unsubscribed from all. When an recipient unsubscribes to a message, they are opted out of that category, that group, or ALL categories. See Unsubscribe Options learn more.

NOTE: A recipient who has unsubscribed from all can still be sent an email on an individual basis.

Example

Unsubscribe a recipient from a message category:

{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"CategoryID":12345,
"ID":12345678910,
"IsAll":false
}

HTTP POST

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

POST Parameters

Required Parameters

Parameter	Value	Description
SessionID	String	This is an authentication token that can be obtained by making the authenticate call.
UserID	String	The UserID returned in the authenticate call.
ID	Int	The recipient ID of the individual to be unsubscribed.
IsAll	Boolean	This flag can be set to either true or false. If true, the recipient will be marked as unsubscribed from all and will no longer receive any messages from Thrive Marketing Enterprise. If false, the recipient will only be unsubscribed from the conditional parameter below.

Conditional Parameters

You must POST at least one of the following parameters to determine the mailing type that your recipient will be unsubscribed from.

NOTE: You can include both if additional unsubscribe information is desired on the recipient unsubscribe record.

Parameter	Value	Description
CategoryID	Int	The category ID from which you want to unsubscribe the recipient. To get a list of category IDs, see GetMessageCategory/ or GetGroupCategories/. NOTE: This is required if the account unsubscribe type is Unsubscribe from Group Categories or Unsubscribe from Message Categories.
Group	Int	The group ID from which you want to unsubscribe the recipient. To get a list of the group IDs, see GetGroups/. NOTE: This is required if the account unsubscribe type is Unsubscribe from specified groups.

Optional Parameters

The parameter below is not required under any condition.

Parameter	Value	Description
MessageID	Int	Use this parameter to view additional information on the unsubscribe record. To get the message ID, see GetMessageList/.