Manages how sales users view and interact with campaign and lead lists within the sales flow.Documentation Index
Fetch the complete documentation index at: https://developer.instantly.ai/llms.txt
Use this file to discover all available pages before exploring further.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Read-only |
timestamp_created | string (date-time) | Yes | Date and time when sales flow created (read-only) |
organization_id | string (uuid) | Yes | Organization ID associated with the sales flow (read-only) |
name | string | Yes | Name of the sales flow |
is_default | boolean, nullable | No | Indicates whether this sales flow is set as the default one for the user or workspace. |
queries | array | Yes | An object containing the sales flow queries |
queries[].actionType | string | No | Possible values: reply, email-open, last-contacted, link-click, lead-status, lead-status-change |
queries[].values | object | No | |
queries[].values.occurrence-days | number | No | |
queries[].values.occurrence-count | object | No | |
queries[].values.occurrence-count.condition | string | No | Possible values: more, less, equal |
queries[].values.occurrence-count.count | number | No | |
queries[].values.lead-status | object | No | |
queries[].values.lead-status.status | number | No | |
queries[].values.lead-status.condition | string | No | Possible values: is, is-not |
created_by | string (uuid) | Yes | UUID of the user who created the sales flow. (read-only) |
list_id | string, nullable | No | The ID of the list, can be “all-lists” in case of all. |
campaign_id | string, nullable | No | The ID of the campaign. Set to null when “all-campaigns” is passed. |
list_name | string, nullable | No | The name of the list. (read-only) |
campaign_name | string, nullable | No | The name of the campaign. (read-only) |