Marketing Automation
GET /workflow
Get list of Automation workflows
Returns status code
200
Request url
/workflow?page=4&perPage=30
Request params
Field name | Field type | Field description |
---|---|---|
page | integer | Specify which page of results return. |
perPage | integer | Specify how many results per page should be returned |
Example Response
[
{
"workflowId": "Vlfo",
"name": "Draft 2016-05-02 10:20:22",
"status": "incomplete",
"dateStart": "2016-05-02T08:21:00+0000",
"dateStop": null,
"subscriberStatistics": {
"completedCount": "0",
"inProgressCount": "0"
}
},
{
"workflowId": "VlP1",
"name": "Draft 2016-05-02 10:21:54",
"status": "active",
"dateStart": "2016-05-02T08:21:00+0000",
"dateStop": null,
"subscriberStatistics": {
"completedCount": "13",
"inProgressCount": "2"
}
}
]
POST /workflow/{id}
Update workflow status
Returns status code
201
Example Request Body
{
"status": "active"
}
Body params
Field name | Field type | Field description |
---|---|---|
status (required) | string | Accepted values: active, inactive |
Example Response
{
"workflowId": "Vlfo",
"name": "Draft 2016-05-02 10:20:22",
"status": "active",
"dateStart": "2016-05-02T08:21:00+0000",
"dateStop": null,
"subscriberStatistics": {
"completedCount": "0",
"inProgressCount": "0"
}
}
Possible Errors
GET /workflow/{id}
Get Automation workflow details
Returns status code
200
Example Response
[
{
"workflowId": "Vlfo",
"name": "Draft 2016-05-02 10:20:22",
"status": "incomplete",
"dateStart": "2016-05-02T08:21:00+0000",
"dateStop": null,
"subscriberStatistics": {
"completedCount": "0",
"inProgressCount": "0"
}
}
]