Workflows

Because of the complexity of Workflows, the endpoint does not allow for Create functionality, but it will allow you to Retrieve, Update, and Delete workflows. The following actions can be performed on this resource...

Retrieve All Workflows
Retrieve a Specific Workflow
Edit a Specific Workflow
Delete a Specific Workflow

Retrieve All Workflows

By default, the first set of 50 workflows will be returned, but you can modify this number with limit and offset values in the query string. The max limit for a single request is 10,000.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/workflows?limit=25&offset=10

Example Response:


            
                
            
{
    "data": [
        {
            "workflow_id": 444444,
            "_brand_id": 123456789,
            "name": "Gather First and Last Name",
            "description": "Will kick off when contact is created.",
            "entry_rule": "oneAtTime",
            "active": 0,
            "created": "2024-11-13 02:41:43",
            "last_updated": "2024-11-20 17:38:34",
            "last_activated": "2024-11-13 02:41:43",
            "last_deactivated": "2024-11-20 17:38:34",
            "last_cleared": null
        }
    ],
    "pagingData": {
        "prevPage": null,
        "currentPage": null,
        "nextPage": null,
        "currentPageString": null,
        "hasMore": false
    }
}

Retrieve a Specific Workflow

Retrieves a single workflow with the Workflow ID equal to {id}.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/workflows/{{id}}

Example Response:


            
                
            
{
    "workflow_id": 444444,
    "_brand_id": 123456789,
    "name": "Gather First and Last Name",
    "description": "Will kick off when contact is created.",
    "entry_rule": "oneAtTime",
    "active": 0,
    "created": "2024-10-30 13:11:02",
    "last_updated": "2024-11-20 17:10:32",
    "last_activated": "2024-11-20 15:47:59",
    "last_deactivated": "2024-11-20 17:10:32",
    "last_cleared": "2024-11-20 15:59:02"
}

Edit a Specific Workflow

Allows you to edit existing workflows. You can target an existing workflow by passing the workflow ID in your PUT request.

PUT https://dev.slicktext.com/v1/brands/{{brand_id}}/workflows/{{id}}

Arguments:

PARAMETER	DESCRIPTION
name	Name of workflow
description	Description of workflow
entry_rule	Determines entry rules for a workflow (once, oneAtTime, or multiple)
active	1 for active, 0 for inactive

Example Response:


            
                
            
{
    "workflow_id": 444444,
    "_brand_id": 123456789,
    "name": "Gather First and Last Name",
    "description": "Will kick off when contact is created.",
    "entry_rule": "oneAtTime",
    "active": 0,
    "created": "2024-10-30 13:11:02",
    "last_updated": "2024-11-20 17:10:32",
    "last_activated": "2024-11-20 15:47:59",
    "last_deactivated": "2024-11-20 17:10:32",
    "last_cleared": "2024-11-20 15:59:02"
}

Delete a Specific Workflow

Deletes an existing workflow with the Workflow ID equal to {id}. Using this action, the workflow is simply removed completely from the brand.

DELETE https://dev.slicktext.com/v1/brands/{{brand_id}}/workflows/{{id}}

Example Response:

[]