digitaluapi

<back to all web services

CampaignsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/campaigns
CampaignsAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodyintYes
NamebodystringYes
DescriptionbodystringYes
AvatarsIdbodylongYes
SchedulesIdbodylongYes
MessageTonesIdbodyintYes
StatusCodesIdbodylongYes
CampaignsAddResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsIdformintNo
NameformstringNo
DescriptionformstringNo
AvatarsIdformlongNo
SchedulesIdformlongNo
MessageTonesIdformintNo
StatusCodesIdformlongNo
ResponseStatusformResponseStatusNo

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 /campaigns HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"TenantsId":0,"Name":"String","Description":"String","AvatarsId":0,"SchedulesId":0,"MessageTonesId":0,"StatusCodesId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TenantsId":0,"Name":"String","Description":"String","AvatarsId":0,"SchedulesId":0,"MessageTonesId":0,"StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}