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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GroupName: String,
	SearchGuid: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T01:56:48.2404069-04:00,
	ServerID: WS-5-59-079,
	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-03T03:36:58.8687656-04:00,
	Device: Desktop
}