SearchRecipient/ searches for recipients based on the criteria submitted in the call.
Example
Search Recipients:
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"Email": "test@higherlogic.com",
"PageSize":100,
"PageNo":1
}
HTTP POST
https://dna.magnetmail.net/ApiAdapter/Rest/SearchRecipient/
POST parameters
NOTE: This call does not have conditional parameters.
Required parameters
NOTE: At least one optional parameter must be included as well.
| 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. |
Optional parameters
| 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. |
| String | The email address for the recipient record. | |
| EmailConfirmed | Boolean | If your Higher Logic Thrive Marketing Enterprise (Thrive Marketing Enterprise) account uses a Subscription Management Page with the Double opt-in functionality enabled, this flag will either be True or False. If Double opt-in is not enabled, all results will reflect True. |
| EmailSendSuppress | Boolean | Whether recipient has been suppressed. If marked true, the recipient will no longer receive any emails from Thrive Marketing Enterprise. |
| Fax | String | The fax number for the recipient record. |
| ID | Int | The recipient ID. |
| FirstName | String | The first name for the recipient record. |
| LastName | String | The last name for the recipient record. |
| PageNo | Int | The page number for this call. |
| PageSize | Int | The number of how many records should be returned per page. |
| 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 only receive the text-version of an email message. |
| Unsubscribed | Boolean | Whether recipient has been unsubscribed. |
| 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. |