digitaluapi

<back to all web services

SendCampaignCommunicationsTest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET POST/campaign/communications/test/{ScheduleInstancesId}Get Campaign Communications
SendCampaignCommunicationsTest Parameters:
NameParameterData TypeRequiredDescription
ScheduleInstancesIdpathlongYes
EmailAddressbodystringYes
MobileNumberbodystringYes
NoOfRecordsbodyintNo
SendCampaignCommunicationsResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformboolNo
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/communications/test/{ScheduleInstancesId} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ScheduleInstancesId":0,"EmailAddress":"String","MobileNumber":"String","NoOfRecords":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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