An unsubscribe is a recipient-triggered action. In Real Magnet, 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.
Unsubscribe a recipient from a message category:
|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.|
This flag can be set to either true or false.
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.
|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.
The parameter below is not required under any condition.
|MessageID||Int||Use this parameter to view additional information on the unsubscribe record. To get the message ID, see GetMessageList/.|