Contributors:
Workflows API
Create, Retrieve, Update and Delete Workflows via the public API endpoint using "where" filtering.
GET Workflows List
Retrieves a list of Workflows as a JSON response based on your provided query parameters.
/api/v2/admin/workflowsParameters
Parameter
Values
Required
Where
{<where query>}Order_By
<propertyAlias>Offset
<integer>Limit
<integer>Data / Response:
N/A
{
"Items": [
{
"Id": 0,
"Name": "string",
"IsDefault": true,
"DisableSenderReplyTo": true
}
],
"TotalItemsCount": 0
}
POST Workflow Create
Creates a new Workflow based on the provided data.
/api/v2/admin/workflowsData / Response:
{
"Name": "string",
"EmailId": 1,
"DisableSenderReplyTo": true,
"Recipients": [
"string"
]
}
{
"Id": 0,
"Name": "string",
"IsDefault": true,
"EmailId": 0,
"DisableSenderReplyTo": true,
"Recipients": [
"string"
],
"CreatedDateTime": "2024-01-01T00:00:00.000Z"
}
GET Workflow Item
Retrieves a single Workflow based on the ID passed in the endpoint URL.
/api/v2/admin/workflows/{id}Data / Response:
N/A
{
"Id": 0,
"Name": "string",
"IsDefault": true,
"EmailId": 0,
"DisableSenderReplyTo": true,
"Recipients": [
"string"
],
"CreatedDateTime": "2024-01-01T00:00:00.000Z"
}
PUT Workflow Update
Updates a single Workflow based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/workflows/{id}Data / Response:
{
"Name": "string",
"EmailId": 1,
"DisableSenderReplyTo": true,
"Recipients": [
"string"
]
}
{
"Id": 0,
"Name": "string",
"IsDefault": true,
"EmailId": 0,
"DisableSenderReplyTo": true,
"Recipients": [
"string"
],
"CreatedDateTime": "2024-01-01T00:00:00.000Z"
}
DELETE Workflow Delete
Deletes a single Workflow based on the ID passed in the endpoint URL.
/api/v2/admin/workflows/{id}Data / Response:
N/A
Status 204