TicketUserServices

<back to all web services

SurveyCampaignSendRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/SurveyCampaign/{CampaignId}/Send
SurveyCampaignSendRequest Parameters:
NameParameterData TypeRequiredDescription
CampaignIdpathintNo
Limitbodyint?No
TestModebodyboolNo
TestEmailsbodyList<string>No
UseEnginebodybool?No
SurveyCampaignSendResult Parameters:
NameParameterData TypeRequiredDescription
QueuedformintNo
SkippedformintNo
RemainingformintNo
StatusCodeformintNo
MessageformstringNo

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 /SurveyCampaign/{CampaignId}/Send HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	campaignId: 0,
	limit: 0,
	testMode: False,
	testEmails: 
	[
		String
	],
	useEngine: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	queued: 0,
	skipped: 0,
	remaining: 0,
	statusCode: 0,
	message: String
}