GetGroupRecipients/ retrieves a list of recipients from an existing group and returns the fields:
- CustomMemberID
- RecipientID
Example
Get Group Recipients:
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"GroupID":"123456"
"PageCount":50,
"PageNumber":1
}
HTTP POST
https://dna.magnetmail.net/ApiAdapter/Rest/GetGroupRecipients/
POST Parameters
NOTE: This call does not have conditional or optional 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. |
GroupID | Int | The Group ID of the group for which you want to retrieve recipients. If you don't know the Group ID, use the call GetGroups/ to find it. |
PageCount | Int | The number of how many records should be returned per page. Cannot be more than 2000. |
PageNumber | Int | The page number for this call. To collect the total number of pages, use the call GetGroupDetails/ to get a total number of recipients. |