GetGroupsEx/ allows you to determine if a group already exists in your account. There are several optional parameters (such as "DaysRecent") that you can include in order to filter the results.
Examples
Request
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"DaysRecent":5,
"DisplayStatus":1,
"GroupID":2147483647,
"GroupName":"Payment reminder",
"SubscriptionGroup":1
}
Response
[{
"DateCreated":"\/Date(928164000000-0400)\/",
"DisplayStatus":true,
"GroupID":2147483647,
"GroupName":"Payment reminder",
"LastUpdated":"\/Date(928164000000-0400)\/",
"LastUpdatedLoginID":2147483647,
"SubscriptionGroup":true
}]
HTTP POST
https://dna.magnetmail.net/ApiAdapter/Rest/GetGroupsEx/
POST parameters
NOTE: The parameters in bold text are required; all others are optional.
Parameters
| Parameter | Value | Description |
|---|---|---|
| SessionID | String | The ID of the session. |
| UserID | String | The ID of the mail user or brand. |
| DaysRecent | Int | Provide a value for this parameter to filter the results by groups that were created in the recent number of days. |
| DisplayStatus | Int | Provide a value for this parameter to filter the results by display status. Valid values are 0 (get only those groups that are hidden) and 1 (get only those groups that are not hidden).
TIP: This parameter also supports a value of 2, which returns all groups, hidden and not. You get the same result by not specifying this parameter. |
| GroupID | String | Provide a value for this parameter to filter the results by group ID. |
| GroupName | String | Provide a value for this parameter to filter the results by group name. It will return the group's details if the group exists. |
| SubscriptionGroup | Int | Provide a value for this parameter to filter the results by subscription group. Valid values are 0 (get only those groups that are not on the subscription page) and 1 (get only those groups that are on the subscription page).
TIP: This parameter also supports a value of 2, which returns all groups, on the subscription page and not. You get the same result by not specifying this parameter. |