digitaluapi

<back to all web services

ActionsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/actions
ActionsAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodyintYes
NamebodystringYes
ActionRoutebodystringNo
PaymentActionbodyboolYes
CustomActionbodyboolYes
ActionsAddResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsIdformintNo
NameformstringNo
ActionRouteformstringNo
PaymentActionformboolNo
CustomActionformboolNo
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 /actions HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"TenantsId":0,"Name":"String","ActionRoute":"String","PaymentAction":false,"CustomAction":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TenantsId":0,"Name":"String","ActionRoute":"String","PaymentAction":false,"CustomAction":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}