Skip to main content

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

id
string<uuid>
required
read-only
Example:

"01a1121d-fd44-7c4c-999e-777a2bbc514e"

timestamp_created
string<date-time>
required
read-only

Date and time when sales flow created

Example:

"2026-10-06T16:48:37.700Z"

organization_id
string<uuid>
required
read-only

Organization ID associated with the sales flow

Example:

"01a1121d-fd44-7c4c-999e-777b0981333a"

name
string
required

Name of the sales flow

Example:

"Smart view name"

queries
object[]
required

An object containing the sales flow queries

created_by
string<uuid>
required
read-only

UUID of the user who created the sales flow.

Example:

"01a1121d-fd44-7c4c-999e-777c7b9bda44"

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:

"01a1121d-fd44-7c4c-999e-777d6f76e1d5"

campaign_id
null | string

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

Example:

"01a1121d-fd44-7c4c-999e-777ed5ba7986"

list_name
null | string

The name of the list.

Example:

"List name"

campaign_name
null | string

The name of the campaign.

Example:

"Campaign #1"