openapi: 3.0.0 info: title: Salesflare Accounts Workflows API version: 1.0.0 description: '# Introduction ## Getting Started The Salesflare API allows you to access and build your own applications or integrations that interact with Salesflare. The Salesflare API provides a RESTful interface with JSON-formatted responses to access most Salesflare resources. ## Authentication The Salesflare API uses bearer token based authentication, which means you need to use the key-value pair "Authorization : Bearer APIKEY" in the header to authenticate. You can make an API key in ["Settings" > "API keys"](https://app.salesflare.com/#/settings/apikeys). Click on the large orange "+" button on the bottom right of the screen to create an API key. ![Screenshot API Key Settings](https://lib.salesflare.com/api_docs/screenshot_settings_apikeys.png?v=2) ## Requests All requests must be sent using HTTPS with TLS 1.2 or higher. Please make sure your developer tools support this version of TLS as older versions or SSL are not supported for security reasons. For PUT or POST requests (e.g. create, update), the payload must be provided as JSON in the request body. ## Responses Responses use HTTP status codes, with the most typical ones being: | Code | Meaning | |------------------------|-----------------------| | Successful Responses | | 200 | OK | | Error Responses | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 429 | Too Many Requests | | 500 | Internal Server Error | ## Testing We recommend testing our API with Postman. ### Download specification Our API is documented following the OpenAPI specification. You can download it [here](https://api.salesflare.com/openapi.json) ### Import in Postman To import the collection, open Postman and click Import, then select "Import From Link" Copy & Paste the following link and press the "Import" button: > https://api.salesflare.com/openapi.json ![Screenshot Postman Import](https://lib.salesflare.com/api_docs/screenshot_postman_import.png) ## Support For API questions and support, please email support@salesflare.com or click the chat bubble below.' contact: email: support@salesflare.com x-logo: url: https://lib.salesflare.com/api_docs/sf-logo-inverted.svg backgroundColor: '#0f1528' altText: Salesflare logo servers: - url: https://api.salesflare.com tags: - name: Workflows paths: /workflows: get: summary: List workflows operationId: getWorkflows parameters: - name: limit in: query schema: type: number minimum: 1 default: 20 - name: offset in: query schema: type: number minimum: 0 default: 0 - description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. x-constraint: single: true name: order_by in: query explode: true schema: type: array items: type: string - name: search in: query schema: type: string - x-alternatives: - type: object required: - condition - rules x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string - type: array items: type: object required: - condition x-alternatives: - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean collectionFormat: multi name: q name: q in: query x-type: object x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string schema: type: string tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: array items: type: object properties: id: type: number name: type: string filter: x-alternatives: - type: object properties: ids: type: array x-constraint: single: true items: type: number - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules type: object properties: ids: type: array x-constraint: single: true items: type: number individual_record_filter: type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules team: type: number status: type: string enum: - draft - live - paused - finished - failed - scheduled status_message: type: string record_type: type: string enum: - contact goal: type: string enum: - opened - clicked - replied continuous: type: boolean exit_after_days: type: number schedule_date: type: string format: date-time schedule_time_start: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_time_end: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_days: type: array items: type: number minimum: 0 maximum: 6 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage in: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage exited: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage met_goal: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage archived: type: boolean steps: type: array items: type: object properties: name: type: string order: type: number filter: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules trigger_step: type: number trigger_step_index: type: number trigger_after_days: type: number trigger: type: string enum: - sent - opened - clicked - replied - not_opened - not_replied - not_clicked action_type: type: string enum: - send_email action_config: type: object action_status: type: string action_source: type: number action_source_email: type: string x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage sent: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage interacted: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage replied: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage failed: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage metrics_data: type: object id: type: number workflow: type: number team: type: number archived: type: boolean archived_by: type: number archived_date: type: string format: date-time created_by: type: object properties: id: type: number name: type: string email: type: string picture: type: string required: - id last_modified_by: type: number creation_date: type: string format: date-time modification_date: type: string format: date-time required: - order - id creator_name: type: string created_by: type: number last_modified_by: type: number can_edit: type: boolean creation_date: type: string format: date-time modification_date: type: string format: date-time step_amount: type: number multi_step_before_pro_release: type: boolean scheduled_before_pro_release: type: boolean required: - id - team post: summary: Create a workflow operationId: postWorkflows requestBody: $ref: '#/components/requestBodies/postWorkflowsBody' tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: object properties: id: type: number /campaigns/mergefields: get: summary: Get a workflow's merge fields operationId: getCampaignsMergefields description: Note that this route is currently still under `/campaigns` but might be moved in the future. tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: array items: type: object properties: entity_type: type: string enum: - account - contact display_name: type: string api_field: type: string is_custom: type: boolean custom_type: type: string required: - entity_type - display_name /workflows/{id}: get: summary: Get workflow details operationId: getWorkflowsId parameters: - name: id in: path required: true schema: type: number tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: object properties: id: type: number name: type: string filter: x-alternatives: - type: object properties: ids: type: array x-constraint: single: true items: type: number - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules type: object properties: ids: type: array x-constraint: single: true items: type: number individual_record_filter: type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules team: type: number status: type: string enum: - draft - live - paused - finished - failed - scheduled status_message: type: string record_type: type: string enum: - contact goal: type: string enum: - opened - clicked - replied continuous: type: boolean exit_after_days: type: number schedule_date: type: string format: date-time schedule_time_start: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_time_end: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_days: type: array items: type: number minimum: 0 maximum: 6 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage in: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage exited: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage met_goal: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage archived: type: boolean steps: type: array items: type: object properties: name: type: string order: type: number filter: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules trigger_step: type: number trigger_step_index: type: number trigger_after_days: type: number trigger: type: string enum: - sent - opened - clicked - replied - not_opened - not_replied - not_clicked action_type: type: string enum: - send_email action_config: type: object action_status: type: string action_source: type: number action_source_email: type: string x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage sent: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage interacted: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage replied: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage failed: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage metrics_data: type: object id: type: number workflow: type: number team: type: number archived: type: boolean archived_by: type: number archived_date: type: string format: date-time created_by: type: object properties: id: type: number name: type: string email: type: string picture: type: string required: - id last_modified_by: type: number creation_date: type: string format: date-time modification_date: type: string format: date-time required: - order - id creator_name: type: string created_by: type: number last_modified_by: type: number can_edit: type: boolean creation_date: type: string format: date-time modification_date: type: string format: date-time step_amount: type: number multi_step_before_pro_release: type: boolean scheduled_before_pro_release: type: boolean workflow_steps: type: array items: type: object properties: name: type: string order: type: number filter: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules trigger_step: type: number trigger_step_index: type: number trigger_after_days: type: number trigger: type: string enum: - sent - opened - clicked - replied - not_opened - not_replied - not_clicked action_type: type: string enum: - send_email action_config: type: object action_status: type: string action_source: type: number action_source_email: type: string x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage sent: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage interacted: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage replied: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage failed: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage metrics_data: type: object id: type: number workflow: type: number team: type: number archived: type: boolean archived_by: type: number archived_date: type: string format: date-time created_by: type: object properties: id: type: number name: type: string email: type: string picture: type: string required: - id last_modified_by: type: number creation_date: type: string format: date-time modification_date: type: string format: date-time required: - order - id required: - id - team put: summary: Update a workflow operationId: putWorkflowsId parameters: - name: id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/postWorkflowsBody' tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: object properties: success: type: boolean /workflows/{id}/audience/{record_id}: put: summary: Re-enter or exit an entity from a workflow operationId: putWorkflowsIdAudienceRecord_id parameters: - name: id in: path required: true schema: type: number - description: This is the entity id. For email workflows this should be the contact id. name: record_id in: path required: true schema: type: number requestBody: content: application/json: schema: type: object properties: exited: type: boolean description: Setting `exited` to `true` will exit the entity from the workflow. Setting `exited` to `false` will re-enter the entity into the workflow. met_goal: type: boolean description: Setting `met_goal` of a workflow record to `false` is currently not possible. tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: object properties: success: type: boolean components: requestBodies: postWorkflowsBody: content: application/json: schema: type: object properties: name: type: string filter: x-alternatives: - type: object description: When you provide `ids`, all other filter options are ignored. properties: ids: type: array x-constraint: single: true items: type: number - x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules type: object description: When you provide `ids`, all other filter options are ignored. properties: ids: type: array x-constraint: single: true items: type: number individual_record_filter: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules status: type: string enum: - live - paused - scheduled - draft status_message: type: string record_type: type: string enum: - contact goal: type: string enum: - opened - clicked - replied continuous: type: boolean exit_after_days: type: number schedule_date: type: string format: date-time schedule_time_start: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_time_end: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_days: type: array items: type: number minimum: 0 maximum: 6 steps: type: array items: type: object properties: id: type: number name: type: string order: type: number filter: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string enum: - equal - not_equal - in - not_in - less - less_or_equal - greater - greater_or_equal - between - not_between - begins_with - not_begins_with - contains - not_contains - ends_with - not_ends_with - is_empty - is_not_empty - is_null - is_not_null - 'true' - 'false' - past_less - past_exactly - past_more_than - future_less - future_exactly - future_more_than - after - 'on' - before - is - is_not value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules trigger_step: type: number trigger_step_index: type: number trigger_after_days: type: number trigger: type: string enum: - sent - opened - clicked - replied - not_opened - not_replied - not_clicked action_type: type: string enum: - send_email action_config: type: object action_status: type: string action_source: type: number action_source_email: type: string x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage sent: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage interacted: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage replied: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage failed: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage metrics_data: type: object required: - order required: - name x-tagGroups: - name: General tags: - Tasks - Accounts - Contacts - Opportunities - Workflows - Insights - name: Interactions tags: - Calls - Meetings - Internal Notes - name: User Management tags: - Users - Groups - name: Configuration tags: - Regional Settings - Pipelines - Custom Fields - Email Data Sources - Tags - Filter Fields - Persons