Sales flow

{
  "id": "019f985c-63a9-761e-ac81-734243aea911",
  "timestamp_created": "2026-07-25T08:20:19.497Z",
  "organization_id": "019f985c-63a9-761e-ac81-734367aba505",
  "name": "Smart view name",
  "queries": [
    {
      "actionType": "email-open",
      "values": {
        "occurrence-days": 1
      }
    }
  ],
  "created_by": "019f985c-63a9-761e-ac81-7344c9016059",
  "is_default": true,
  "list_id": "019f985c-63a9-761e-ac81-7345810095ba",
  "campaign_id": "019f985c-63a9-761e-ac81-73463490f4db",
  "list_name": "List name",
  "campaign_name": "Campaign #1"
}

Manages how sales users view and interact with campaign and lead lists within the sales flow.

string<uuid>

required

read-only

Example:

"019f985c-63a9-761e-ac81-734243aea911"

timestamp_created

string<date-time>

required

read-only

Date and time when sales flow created

Example:

"2026-07-25T08:20:19.497Z"

organization_id

string<uuid>

required

read-only

Organization ID associated with the sales flow

Example:

"019f985c-63a9-761e-ac81-734367aba505"

name

string

required

Name of the sales flow

Example:

"Smart view name"

queries

object[]

required

An object containing the sales flow queries

Show child attributes

created_by

string<uuid>

required

read-only

UUID of the user who created the sales flow.

Example:

"019f985c-63a9-761e-ac81-7344c9016059"

is_default

null | boolean

Indicates whether this sales flow is set as the default one for the user or workspace.

Example:

true

list_id

null | string

The ID of the list, can be "all-lists" in case of all.

Example:

"019f985c-63a9-761e-ac81-7345810095ba"

campaign_id

null | string

The ID of the campaign. Set to null when "all-campaigns" is passed.

Example:

"019f985c-63a9-761e-ac81-73463490f4db"

list_name

null | string

The name of the list.

Example:

"List name"

campaign_name

null | string

The name of the campaign.

Example:

"Campaign #1"

⌘I

Overview

Getting Started

Guides

Resources

Schemas