YM REST Services

<back to all web services

InformzBulkUploadBySearchGuidRequest

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permissions:/admin/email/, Informz
The following routes are available for this service:
POST/Ams/{ClientID}/InformzBulkUploadBySearchGuidUpload emails and personal data to Informz for search.
InformzBulkUploadBySearchGuidRequest Parameters:
NameParameterData TypeRequiredDescription
GroupNamebodystringNo
SearchGuidbodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo

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}/InformzBulkUploadBySearchGuid HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"GroupName":"String","SearchGuid":"String","UsingRedis":true,"AppInitTime":"2024-05-03T03:25:38.4266254-04:00","ServerID":"WS-6-183-431","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":"2024-05-03T04:24:36.7669198-04:00","Device":"Desktop"}