digitaluapi

<back to all web services

StartCampaign

The following routes are available for this service:
POST/campaign/start/{PublicAccessGuid}Start Campaign
StartCampaign Parameters:
NameParameterData TypeRequiredDescription
PublicAccessGuidpathGuidYes
StartCampaignResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo
ResponseStatusformResponseStatusNo

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /campaign/start/{PublicAccessGuid} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"PublicAccessGuid":"00000000000000000000000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Status":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}