YM REST Services

<back to all web services

InformzFindGroupRequest

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permissions:/admin/email/, Informz
The following routes are available for this service:
POST/Ams/{ClientID}/InformzFindGroupReturn whether the given group already exists.
InformzFindGroupRequest Parameters:
NameParameterData TypeRequiredDescription
GroupNamebodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
InformzFindGroupResponse Parameters:
NameParameterData TypeRequiredDescription
ExistformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"GroupName":"String","UsingRedis":true,"AppInitTime":"2025-01-15T07:36:41.2404784-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-15T08:47:43.2615205-05:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Exist":false}