Saasco logoSaasco logo
Saasco logoSaasco logo

Introduction

Quick StartWhat is Saasco?

Analytics

CRM

Email Marketing

getList WorkflowsgetGet WorkflowpostCreate WorkflowputUpdate WorkflowdelDelete WorkflowpostVerify Workflow Config

Knowledge

Support

Projects

Workflows

Update Workflow

Updates a workflow. Only the fields present in changes are written, so omitted keys stay as they are.

PUT
/projects/{projectId}/workflows/{workflowId}

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

projectIdrequiredstring

ID of the project that owns the workflow.

workflowIdrequiredstring

ID of the workflow to update.

Request Body

application/json

changesrequiredobject

Fields to change. Anything omitted is left as-is.

contactsFilterGroupsarray<object>

Audience filter groups. A contact must match at least one group to enter the workflow.

filtersrequiredarray<object>

Attribute filters combined with groupType.

attributeDistinctIdrequiredstring

Contact attribute distinct id to filter on.

attributeTypestring

Attribute type. Defaults to string when omitted.

Default: "string"Value in: "string" | "number" | "boolean" | "date" | "url" | "email"
operatorrequiredstring

Comparison operator for the attribute value.

Value in: "equals" | "contains" | "notEquals" | "notContains" | "gt" | "gte" | "lt" | "lte" | "on" | "since" | "before" | "between" | "last"
valuerequiredstring

Value to compare the attribute against.

oneDayEventFiltersarray<object>

Event filters evaluated over the last 24 hours only.

eventNamerequiredstring

Analytics event name.

operatorrequiredstring

Whether the contact performed the event in the last 24 hours.

Value in: "performed" | "notPerformed"
groupTyperequiredstring

How filters in this group are combined.

Value in: "AND" | "OR" | "NOT"
requireSubscribedboolean

When true, the group is ANDed with $subscribed == true. Set by email sending, not the filter UI.

frequencystring

ONCE runs a contact through at most once. EVERY re-enters them each time the trigger fires, subject to maxRuns and minDelay.

Value in: "ONCE" | "EVERY"
maxRunsinteger | null

Maximum times a contact can go through this workflow. Null means no cap.

minDelayAmountinteger | null

Minimum delay between runs for the same contact. Pair with minDelayUnit.

minDelayUnitstring | null

Unit for minDelayAmount: MINUTES, HOURS, or DAYS.

namestring

Display name of the workflow.

projectIdstring
statusstring

INACTIVE, PAUSED, or ACTIVE.

Value in: "INACTIVE" | "PAUSED" | "ACTIVE"
triggerEventstring

Name of the analytics event that starts a run, e.g. signup.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://www.saasco.com/api/v2/projects/string/workflows/string" \  -H "Content-Type: application/json" \  -d '{    "changes": {}  }'
{
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "name": "string",
  "projectId": "string",
  "triggerEvent": "string",
  "maxRuns": -9007199254740991,
  "minDelayAmount": 5,
  "minDelayUnit": "MINUTES",
  "frequency": "ONCE",
  "status": "INACTIVE",
  "contactsFilterGroups": [
    {
      "filters": [
        {
          "attributeDistinctId": "string",
          "attributeType": "string",
          "operator": "equals",
          "value": "string"
        }
      ],
      "oneDayEventFilters": [
        {
          "eventName": "string",
          "operator": "performed"
        }
      ],
      "groupType": "AND",
      "requireSubscribed": true
    }
  ]
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Create Workflow

Creates a workflow definition: the trigger event, audience filters, frequency, and delay between runs. Creating one never starts a run and never sends anything. Steps and edges are added separately.

Delete Workflow

Permanently deletes a workflow and everything cascading from it: steps, edges, runs, and run logs. Cannot be undone.