A subscribe is a recipient-triggered action. In Higher Logic Thrive Marketing Enterprise (Thrive Marketing Enterprise), your options for subscribing recipients are outlined in Unsubscribe Options.
Subscribes are either by category or group: Once an individual subscribes to a message, they're either opted into that category or group.
Example
Subscribe a recipient to a message category:
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"Category":12345,
"ID":12345678910,
"RemoveAllUnsubscribes":true
}
HTTP POST
https://dna.magnetmail.net/ApiAdapter/Rest/SubscribeRecipient/
POST Parameters
Required Parameters
| 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 subscribe. |
| RemoveAllUnsubscribes | Boolean |
This flag can be set to either true or false.
|
Conditional Parameters
You must POST at least one of the following parameters to determine the mailing type that your recipient will be subscribed to.
NOTE: If your unsubscribe setting is MESSAGE CATEGORY, you must include either the Category ID or BOTH conditional parameters.
| Parameter | Value | Description |
|---|---|---|
| Category | Int | The message category ID which you want to subscribe the recipient to. To get a list of category IDs, see GetMessageCategory/ or GetGroupCategories/. |
| Group | Int | The group ID which you want to subscribe the recipient to. To get a list of the group IDs, see GetGroups/. |
Optional Parameters
Unsubscribe from All
If a recipient has previously unsubscribed from all, the subscribe call will need to also set RemoveAllUnsubscribes to True in order for that recipient to begin receiving messages again. However, this flag can remain unchanged if you would like to continue to log subscribes and unsubscribes. This would leave the recipient unsubscribed, and unavailable to send to.
Example
John Doe has selected the Unsubscribe from All link in a message. This has changed the flag in his record.
He had also previously unsubscribed from Categories A, B, and C. A user of the Thrive Marketing Enterprise account has decided that they would like to re-subscribe this recipient to Category A. However, they would also like for the individual to remain opted out of the prior categories and to remain unsubscribed from all. Creating the API call, the recipient is subscribed to the A category and the RemoveAllUnsubscribes parameter is set to False.
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"Category":12345,
"ID":12345678910,
"RemoveAllUnsubscribes":false
}
The result will have a recipient that is unsubscribed to Categories B and C, and that is still unsubscribed from all.