Requires any of the roles: | admin, oauthadmin | Required permissions: | /admin/email/, Informz |
POST | /Ams/{ClientID}/InformzFindGroup | Return whether the given group already exists. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GroupName | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UsingRedis | form | bool | No | |
AppInitTime | form | DateTime | No | |
ServerID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientID | form | int | No | |
ResponseStatus | form | ResponseStatus | No | |
BypassCache | form | bool | No | |
DateCached | form | DateTime | No | |
Device | form | Device | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Exist | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Ams/{ClientID}/InformzFindGroup HTTP/1.1
Host: ws.yourmembership.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
GroupName: String,
UsingRedis: True,
AppInitTime: 2025-01-15T08:36:36.5101848-05:00,
ServerID: WS-5-212-532,
ClientID: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
BypassCache: False,
DateCached: 2025-01-15T09:04:11.5570448-05:00,
Device: Desktop
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Exist: False }