Sales flow

{
  "id": "019fef96-3d5e-7a13-ade3-6db6d8359c91",
  "timestamp_created": "2026-08-11T06:50:28.574Z",
  "organization_id": "019fef96-3d5e-7a13-ade3-6db75fa851e3",
  "name": "Smart view name",
  "queries": [
    {
      "actionType": "email-open",
      "values": {
        "occurrence-days": 1
      }
    }
  ],
  "created_by": "019fef96-3d5e-7a13-ade3-6db877c469ad",
  "is_default": true,
  "list_id": "019fef96-3d5e-7a13-ade3-6db953f3ed9d",
  "campaign_id": "019fef96-3d5e-7a13-ade3-6dba65e554bb",
  "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:

"019fef96-3d5e-7a13-ade3-6db6d8359c91"

timestamp_created

string<date-time>

required

read-only

Date and time when sales flow created

Example:

"2026-08-11T06:50:28.574Z"

organization_id

string<uuid>

required

read-only

Organization ID associated with the sales flow

Example:

"019fef96-3d5e-7a13-ade3-6db75fa851e3"

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:

"019fef96-3d5e-7a13-ade3-6db877c469ad"

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:

"019fef96-3d5e-7a13-ade3-6db953f3ed9d"

campaign_id

null | string

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

Example:

"019fef96-3d5e-7a13-ade3-6dba65e554bb"

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