# Salesflare Salesflare is a CRM platform that helps small and medium-sized B2B businesses track and manage their sales pipelines, contacts, and customer relationships with automated data entry and smart insights. - **Category:** crm - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 63 - **Triggers:** 0 - **Slug:** `SALESFLARE` - **Version:** 20260217_00 ## Tools ### Add Account Contacts **Slug:** `SALESFLARE_ADD_ACCOUNT_CONTACTS` Tool to add contacts to a specific account in Salesflare. Use when you need to link existing contacts to an account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contacts` | array | Yes | List of contact objects to add to the account. Each object must contain a contact ID. | | `account_id` | integer | Yes | The unique ID of the account to add contacts to | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Account **Slug:** `SALESFLARE_CREATE_ACCOUNT` Tool to create a new account in Salesflare. Use when you need to add a new company or organization to your CRM. If update_if_exists is true and an account with matching domain exists, it will be updated instead of creating a duplicate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Name of the account/company. This is the primary identifier for the account. | | `size` | integer | No | Company size (number of employees) | | `tags` | array | No | List of tags for categorizing the account | | `email` | string | No | Primary email address for the account | | `links` | string | No | Additional links related to the account | | `owner` | integer | No | User ID of the account owner in Salesflare | | `custom` | object | No | Custom fields as key-value pairs. Keys should match custom field names defined in your Salesflare account. Values can be strings, numbers, or booleans. | | `domain` | string | No | Company domain name. Used for matching and enrichment. If update_if_exists is true, accounts with matching domain will be updated instead of creating duplicates. | | `picture` | string | No | URL to company logo or picture | | `website` | string | No | Company website URL | | `addresses` | array | No | List of addresses associated with the account | | `customers` | array | No | List of customers associated with this account | | `description` | string | No | Description or notes about the account | | `phone_number` | string | No | Primary phone number for the account | | `phone_numbers` | array | No | List of phone numbers associated with the account | | `parent_account` | integer | No | ID of the parent account if this is a subsidiary or child account | | `email_addresses` | array | No | List of email addresses associated with the account | | `social_profiles` | array | No | List of social media profile URLs (LinkedIn, Twitter, etc.) | | `update_if_exists` | boolean | No | If true and an account with matching domain exists, update it instead of creating a new one. If false, always create a new account. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create call **Slug:** `SALESFLARE_CREATE_CALL` Tool to create one or more call records in Salesflare. Use when logging calls with contacts or accounts. Each call requires a date and participants list (can be empty for call log sync). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `calls` | array | Yes | List of call records to create. Each call must have a date and participants list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Contact **Slug:** `SALESFLARE_CREATE_CONTACT` Tool to create new contacts in Salesflare. Use when you need to add contact records to the system. Accepts single or multiple contacts. If creating one contact, response contains a single object; if multiple, an array is returned. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `force` | boolean | No | When false, the contact will not be created if a contact with the same email address used to exist. Defaults to true. | | `contacts` | array | Yes | List of contacts to create. If a single contact is provided, the response will be a single object; if multiple, an array will be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Custom Field **Slug:** `SALESFLARE_CREATE_CUSTOM_FIELD` Creates a new custom field for accounts, contacts, or opportunities in Salesflare. Use when you need to add custom data fields to track specific information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Name of the custom field. | | `type` | integer | No | Type of the custom field. Common values: 1 for text, 2 for number, 3 for date, 4 for checkbox, 5 for select, 6 for multi-select. | | `enabled` | boolean | No | Whether the custom field is enabled. | | `options` | array | No | List of options for select/multi-select type fields. | | `archived` | boolean | No | Whether the custom field is archived. | | `max_date` | string | No | Maximum date for date type fields in ISO 8601 format. | | `min_date` | string | No | Minimum date for date type fields in ISO 8601 format. | | `pipeline` | integer | No | Pipeline ID to associate with the custom field (for opportunities). | | `required` | boolean | No | Whether the custom field is required. | | `item_class` | string ("accounts" | "contacts" | "opportunities") | Yes | The entity type for which the custom field is created. Must be one of: accounts, contacts, or opportunities. | | `max_number` | number | No | Maximum value for number type fields. | | `min_number` | number | No | Minimum value for number type fields. | | `order_alphabetically` | boolean | No | Whether options should be ordered alphabetically. Default is false. | | `default_boolean_value` | boolean | No | Default value for boolean/checkbox type fields. | | `users_can_add_options` | boolean | No | Whether users can add new options to select/multi-select fields. | | `predefined_customfield` | integer | No | ID of a predefined custom field template to use. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Internal Note **Slug:** `SALESFLARE_CREATE_INTERNAL_NOTE` Tool to create an internal note in Salesflare associated with an account. Use when you need to add notes for tracking interactions or important information about an account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Content of the internal note | | `date` | string | No | Date and time for the note in ISO 8601 format (e.g., '2024-01-15T10:30:00Z'). If not provided, current timestamp will be used. | | `account` | integer | Yes | Account ID to associate the internal note with | | `mentions` | array | No | List of user IDs to mention in the note | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Meeting **Slug:** `SALESFLARE_CREATE_MEETING` Create a new meeting record in Salesflare. Use when scheduling meetings with contacts or logging past meetings/calls. Supports both live meetings and phone calls with customizable details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Meeting start date and time in ISO 8601 format (e.g., '2026-02-15T14:00:00.000Z'). This is the scheduled start time of the meeting. | | `type` | string ("meeting-live" | "meeting-phone") | No | Type of meeting | | `notes` | string | No | Meeting notes or minutes. Use this field to record what was discussed or decided during the meeting. | | `minutes` | string | No | DEPRECATED: Use the 'notes' property instead. Meeting minutes recorded after the meeting. | | `subject` | string | No | Subject or title of the meeting. Maximum 200 characters. This will be the displayed name of the meeting. | | `end_date` | string | No | Meeting end date and time in ISO 8601 format (e.g., '2026-02-15T15:00:00.000Z'). If not provided, the meeting duration will be unspecified. | | `phone_type` | string | No | Type of phone call (e.g., 'inbound', 'outbound'). Relevant when type is 'meeting-phone'. | | `description` | string | No | Detailed description or notes about the meeting. Provides additional context about the meeting agenda or outcomes. | | `participants` | array | Yes | List of participant IDs (Salesflare contact IDs) attending the meeting. At least one participant is required unless it's a call log sync. | | `phone_number_hash` | string | No | Phone number hash for call log synchronization. Used when syncing call logs from external systems. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Opportunity **Slug:** `SALESFLARE_CREATE_OPPORTUNITY` Tool to create a new opportunity in Salesflare. Use when you need to add a sales opportunity or deal to the system. An opportunity represents a potential sale associated with an account (company). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Name/title of the opportunity (e.g., 'Q1 Enterprise Deal', 'Renewal Contract'). If not provided, may be auto-generated by Salesflare. | | `tags` | array | No | List of tags to categorize the opportunity. | | `owner` | integer | No | User ID of the opportunity owner. Use GET_ME or LIST_USERS to find valid user IDs. | | `stage` | integer | No | Pipeline stage ID. Use LIST_STAGES to find valid stage IDs for your pipeline. | | `units` | number | No | Number of units for this opportunity (e.g., number of licenses, seats, or products). | | `value` | number | No | Total monetary value of the opportunity. Must be non-negative. | | `closed` | boolean | No | Whether the opportunity is closed. Set to true when the deal is won or lost. | | `custom` | object | No | Custom fields as key-value pairs. Use GET_CUSTOM_FIELDS to discover available custom field keys. | | `account` | integer | Yes | REQUIRED. ID of the account (company) to associate this opportunity with. Use LIST_ACCOUNTS to find available account IDs. | | `creator` | integer | No | User ID of the person who created this opportunity. Defaults to the authenticated user if not specified. | | `assignee` | integer | No | User ID of the person assigned to this opportunity. Use GET_ME or LIST_USERS to find valid user IDs. | | `currency` | integer | No | Currency ID for the opportunity value. Use LIST_CURRENCIES to find valid currency IDs. | | `frequency` | string ("annually" | "weekly" | "monthly" | "daily") | No | Frequency type for recurring opportunities. | | `close_date` | string | No | Expected close date in ISO 8601 date-time format (e.g., '2024-12-31T23:59:59Z'). | | `start_date` | string | No | Opportunity start date in ISO 8601 date-time format. | | `lead_source` | integer | No | Lead source ID indicating where this opportunity originated. Use LIST_LEAD_SOURCES to find valid IDs. | | `lost_reason` | integer | No | Lost reason ID if the opportunity is marked as lost. Use LIST_LOST_REASONS to find valid IDs. | | `probability` | number | No | Win probability as a percentage (0-100). Higher values indicate greater likelihood of closing. | | `main_contact` | integer | No | Contact ID of the primary contact for this opportunity. Use LIST_CONTACTS to find valid contact IDs. | | `contract_end_date` | string | No | Contract end date in ISO 8601 date-time format. | | `contract_start_date` | string | No | Contract start date in ISO 8601 date-time format. | | `recurring_price_per_unit` | number | No | Recurring price per unit for subscription-based opportunities. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Tag **Slug:** `SALESFLARE_CREATE_TAG` Tool to create a new tag in Salesflare. Use when you need to add a new tag for categorizing accounts, contacts, or opportunities. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the tag to create. Use descriptive names to categorize accounts, contacts, or opportunities effectively. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Task **Slug:** `SALESFLARE_CREATE_TASK` Tool to create a new task in Salesflare. Use when you need to add a task or to-do item to the system. Tasks help track follow-ups, calls, meetings, and other action items. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account` | integer | No | ID of the account (company) to associate this task with. Use LIST_ACCOUNTS to find available account IDs. | | `assignees` | array | No | List of user IDs to assign this task to. Use GET_CURRENT_USER or LIST_USERS to find valid user IDs. If not specified, may default to the authenticated user. | | `description` | string | Yes | REQUIRED. Description or title of the task. This is the main content describing what needs to be done. | | `reminder_date` | string | No | Reminder date for the task in ISO 8601 date format (YYYY-MM-DD) or date-time format (YYYY-MM-DDTHH:MM:SSZ). The system will send a reminder on this date. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Workflow **Slug:** `SALESFLARE_CREATE_WORKFLOW` Tool to create a new workflow (email automation sequence) in Salesflare. Use when you need to set up automated email sequences or campaigns for contacts. Only the workflow name is required; all other fields are optional for configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `goal` | string ("opened" | "clicked" | "replied") | No | Goal types for workflow completion. | | `name` | string | Yes | Name of the workflow. This is the only required field. | | `steps` | array | No | List of steps in the workflow sequence. Each step must have an 'order' field. | | `filter` | object | No | Filter configuration for workflow targeting. | | `status` | string ("live" | "paused" | "scheduled" | "draft") | No | Status options for workflow. | | `continuous` | boolean | No | Whether the workflow runs continuously or only once per record | | `record_type` | string ("contact") | No | Record type for workflow targets. | | `schedule_date` | string | No | Date and time to start the workflow in ISO 8601 format (e.g., '2024-12-31T10:00:00Z') | | `schedule_days` | array | No | Days of the week to run the workflow (0=Sunday, 1=Monday, ..., 6=Saturday) | | `status_message` | string | No | Status message or notes about the workflow | | `exit_after_days` | number | No | Number of days after which records automatically exit the workflow | | `schedule_time_end` | string | No | End time for daily workflow execution in HH:MM:SS format (e.g., '17:00:00') | | `schedule_time_start` | string | No | Start time for daily workflow execution in HH:MM:SS format (e.g., '09:00:00') | | `individual_record_filter` | object | No | Advanced filtering configuration for individual records. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Account **Slug:** `SALESFLARE_DELETE_ACCOUNT` Tool to permanently delete an account from Salesflare. Use when you need to remove an account from the system. WARNING: This action cannot be undone and permanently removes the account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | integer | Yes | Unique numeric identifier of the account to delete. WARNING: This permanently removes the account from the Salesflare system. This action cannot be undone. Ensure you have the correct account ID before deletion. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Contact **Slug:** `SALESFLARE_DELETE_CONTACT` Tool to delete a contact from Salesflare. Use when you need to remove a contact by their unique identifier after confirming this detail. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contact_id` | integer | Yes | Unique identifier of the contact to delete from Salesflare. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Custom Field **Slug:** `SALESFLARE_DELETE_CUSTOM_FIELD` Tool to delete a custom field from Salesflare. Use this to permanently remove a custom field from accounts, contacts, or opportunities. The custom field and all its data will be deleted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The unique numeric ID of the custom field to delete. | | `item_class` | string ("accounts" | "contacts" | "opportunities") | Yes | The type of entity the custom field belongs to. Must be one of: accounts, contacts, or opportunities. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Internal Note **Slug:** `SALESFLARE_DELETE_INTERNAL_NOTE` Tool to delete an internal note from Salesflare by its message ID. Use when you need to permanently remove an internal note from the system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message_id` | integer | Yes | Unique identifier of the internal note (message) to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Meeting **Slug:** `SALESFLARE_DELETE_MEETING` Tool to delete a meeting from Salesflare. Use when you need to remove a meeting from the system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `meeting_id` | integer | Yes | The unique identifier of the meeting to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Opportunity **Slug:** `SALESFLARE_DELETE_OPPORTUNITY` Tool to permanently delete an opportunity from Salesflare. Use when you need to remove an opportunity from the system. WARNING: This action cannot be undone and permanently removes the opportunity. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Unique numeric identifier of the opportunity to delete. WARNING: This permanently removes the opportunity from the Salesflare system. This action cannot be undone. Ensure you have the correct opportunity ID before deletion. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Tag **Slug:** `SALESFLARE_DELETE_TAG` Tool to delete a tag from Salesflare. Use when you need to remove a tag from the system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag_id` | integer | Yes | The unique identifier of the tag to delete from the Salesflare system | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Task **Slug:** `SALESFLARE_DELETE_TASK` Tool to delete a task from Salesflare. Use when you need to remove a task from the system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The unique identifier of the task to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Account **Slug:** `SALESFLARE_GET_ACCOUNT` Get detailed information about a specific account by ID. Tool to retrieve complete account details including contact information, addresses, social profiles, tags, and custom fields. Use when you need to fetch information about a specific account in Salesflare. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | integer | Yes | Unique identifier of the account to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get AI Settings **Slug:** `SALESFLARE_GET_AI_SETTINGS` Tool to retrieve AI settings for the Salesflare team. Use when you need to check the current AI configuration for company and user profiles. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact by ID **Slug:** `SALESFLARE_GET_CONTACT` Retrieves detailed information for a specific contact by ID. Use when you need complete contact details including personal info, tags, addresses, and account associations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contact_id` | integer | Yes | Unique numeric identifier of the contact to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current User **Slug:** `SALESFLARE_GET_CURRENT_USER` Tool to retrieve the details of the currently authenticated user. Use when you need to get information about the current user's profile, settings, permissions, or team configuration. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Custom Field Details **Slug:** `SALESFLARE_GET_CUSTOM_FIELD` Tool to retrieve details of a specific custom field. Use when you need to fetch information about a custom field configuration for accounts, contacts, or opportunities. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The unique identifier of the custom field to retrieve | | `item_class` | string ("accounts" | "contacts" | "opportunities") | Yes | The class of item the custom field belongs to (accounts, contacts, or opportunities) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Meeting Details **Slug:** `SALESFLARE_GET_MEETING` Tool to retrieve detailed information about a specific meeting by its ID. Use when you need to fetch meeting details such as subject, date, participants, notes, and other metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `meeting_id` | integer | Yes | The unique identifier of the meeting to retrieve. Must be a valid meeting ID from Salesflare. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Opportunity **Slug:** `SALESFLARE_GET_OPPORTUNITY` Get detailed information about a specific opportunity by ID. Tool to retrieve complete opportunity details including account, contacts, pipeline stage, value, dates, and other metadata. Use when you need to fetch information about a specific opportunity in Salesflare. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Unique identifier of the opportunity to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Stage **Slug:** `SALESFLARE_GET_STAGE` Get detailed information about a specific pipeline stage by ID. Tool to retrieve complete stage details including name, order, probability, and pipeline association. Use when you need to fetch information about a specific stage in Salesflare. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `stage_id` | integer | Yes | Unique identifier of the pipeline stage to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tag Usage **Slug:** `SALESFLARE_GET_TAG_USAGE` Get tag usage details including workflows, saved filters, and reports. Tool to retrieve information about where a specific tag is being used across workflows, saved filters, and reports in Salesflare. Use when you need to understand tag dependencies before deletion or to audit tag usage. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag_id` | integer | Yes | Unique identifier of the tag to retrieve usage information for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User **Slug:** `SALESFLARE_GET_USER` Tool to retrieve details of a specific user by their ID. Use when you need to get information about a user's profile, settings, or permissions in Salesflare. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | integer | Yes | Unique identifier of the user to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Workflow **Slug:** `SALESFLARE_GET_WORKFLOW` Get detailed information about a specific workflow by ID. Tool to retrieve complete workflow details including steps, analytics, filters, scheduling, and status information. Use when you need to fetch information about a specific workflow in Salesflare. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Unique identifier of the workflow to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Workflow Merge Fields **Slug:** `SALESFLARE_GET_WORKFLOW_MERGE_FIELDS` Tool to retrieve available merge fields for workflows in Salesflare. Use when you need to get the list of fields that can be inserted into workflow templates or email campaigns. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Account Messages **Slug:** `SALESFLARE_LIST_ACCOUNT_MESSAGES` Tool to retrieve a list of messages associated with a specific account in Salesflare. Use when you need to view communication history, emails, or notes linked to an account. Supports filtering by date range and pagination with limit parameter. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Filter messages created after this timestamp. Use ISO 8601 date-time format (e.g., '2024-01-01T00:00:00.000Z'). Only messages created after this date will be returned. Defaults to Unix epoch start (1970-01-01T00:00:00.000Z) if not specified. | | `limit` | integer | No | Maximum number of messages to return in a single request. Use this to control pagination and response size. Defaults to 10 if not specified. Recommended range: 1-100. | | `before` | string | No | Filter messages created before this timestamp. Use ISO 8601 date-time format (e.g., '2024-12-31T23:59:59.000Z'). Only messages created before this date will be returned. | | `account_id` | integer | Yes | The unique identifier of the account whose messages you want to retrieve. This is a numeric ID representing the account in Salesflare. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List accounts **Slug:** `SALESFLARE_LIST_ACCOUNTS` Tool to list accounts with various filtering options including search, name, creation dates, size, domain, tags, address, and hotness level. Use when you need to retrieve multiple accounts with specific criteria or browse all accounts in Salesflare. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Quick search query parameter for filtering accounts. | | `id` | array | No | Filter accounts by specific IDs. Provide a list of account IDs to retrieve only those accounts. | | `tag` | array | No | Filter accounts by tag IDs. Provide a list of tag IDs to filter accounts that have these tags. | | `name` | string | No | Filter accounts by exact or partial name match. | | `limit` | integer | No | Maximum number of accounts to return. Defaults to 10 if not specified. | | `custom` | string | No | Custom filter query for advanced filtering. Consult API documentation for syntax. | | `domain` | array | No | Filter accounts by domain names. Provide a list of domains to match. | | `export` | string | No | Export format if requesting data export. Consult API documentation for supported formats. | | `offset` | integer | No | Number of records to skip for pagination. Use with limit for paginated results. | | `search` | string | No | Search term to filter accounts. Searches across account name, domain, and other text fields. | | `details` | boolean | No | Whether to include detailed account information in the response. Defaults to true. | | `hotness` | integer ("1" | "2" | "3") | No | Hotness level enumeration: 1: Room temp, 2: Hot, 3: On fire | | `max_size` | integer | No | Filter accounts with a maximum company size (number of employees). | | `min_size` | integer | No | Filter accounts with a minimum company size (number of employees). | | `order_by` | array | No | Sort order for results. Can be just 'key' (e.g., 'name') or 'key sortOrder' (e.g., 'name desc'). Defaults to ascending order if not specified. | | `tag.name` | array | No | Filter accounts by tag names. Provide a list of tag names to filter accounts. | | `address.city` | array | No | Filter accounts by city. Provide a list of city names. | | `creation_after` | string | No | Filter accounts created after this date. Use ISO 8601 format (YYYY-MM-DD or full timestamp). | | `address.country` | array | No | Filter accounts by country. Provide a list of country names or codes. | | `creation_before` | string | No | Filter accounts created before this date. Use ISO 8601 format (YYYY-MM-DD or full timestamp). | | `address.state_region` | array | No | Filter accounts by state or region. Provide a list of state/region names. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Contacts **Slug:** `SALESFLARE_LIST_CONTACTS` Tool to list contacts with filtering options. Use when you need to retrieve, search, or filter contacts from Salesflare. Supports extensive filtering by name, email, phone, domain, dates, account, tags, position, and address fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Query string for advanced filtering. Use for complex search queries. | | `id` | array | No | Filter contacts by specific IDs. Provide a list of contact IDs to retrieve. | | `tag` | array | No | Filter contacts by tag IDs. Provide a list of tag IDs. | | `name` | string | No | Filter contacts by name. Partial matches are supported. | | `type` | string ("customer" | "mycontacts") | No | Contact type filter options. | | `email` | string | No | Filter contacts by email address. Partial matches are supported. | | `limit` | integer | No | Maximum number of contacts to return. Defaults to 20. | | `custom` | string | No | Filter by custom fields. Format depends on your custom field configuration. | | `domain` | string | No | Filter contacts by domain. Useful for finding contacts from specific companies. | | `export` | string | No | Export format for the contacts. Specify the desired export format. | | `offset` | integer | No | Number of contacts to skip for pagination. Defaults to 0. | | `search` | string | No | Search contacts by keyword. Searches across multiple fields like name, email, and company. | | `account` | array | No | Filter contacts by account IDs. Provide a list of account IDs. | | `order_by` | array | No | Order results by specified fields. Can be just 'key' (e.g., 'name') or 'key sortOrder' (e.g., 'name desc'). Defaults to ascending order. | | `tag.name` | array | No | Filter contacts by tag names. Provide a list of tag names. | | `address.city` | array | No | Filter contacts by city. Provide a list of city names. | | `phone_number` | string | No | Filter contacts by phone number. Partial matches are supported. | | `position.role` | array | No | Filter contacts by their position/role. Provide a list of role names. | | `creation_after` | string | No | Filter contacts created after this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). | | `address.country` | array | No | Filter contacts by country. Provide a list of country names or codes. | | `creation_before` | string | No | Filter contacts created before this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). | | `includeArchived` | boolean | No | Include archived contacts in the results. Set to true to include archived contacts. | | `modification_after` | string | No | Filter contacts modified after this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). | | `modification_before` | string | No | Filter contacts modified before this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). | | `address.state_region` | array | No | Filter contacts by state or region. Provide a list of state/region names. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Supported Currencies **Slug:** `SALESFLARE_LIST_CURRENCIES` Tool to retrieve a list of supported currencies in Salesflare. Use when you need to know which currencies are available for use in accounts, opportunities, or other financial data. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Custom Field Options **Slug:** `SALESFLARE_LIST_CUSTOM_FIELD_OPTIONS` Tool to list available options for a specific custom field in Salesflare. Use when you need to retrieve the available values for select or multi-select custom fields. Supports filtering options by search string. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `item_class` | string ("accounts" | "contacts" | "opportunities") | Yes | The entity type for which to retrieve custom field options. Must be one of: accounts (for account custom fields), contacts (for contact custom fields), or opportunities (for opportunity custom fields). | | `search_string` | string | No | Optional search string to filter the options. Only options matching this search string will be returned. | | `custom_field_api_field` | string | Yes | The API field name of the custom field to retrieve options for. This is the unique identifier for the custom field (e.g., 'lost_reason', 'priority_level', 'customer_type'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Custom Fields **Slug:** `SALESFLARE_LIST_CUSTOM_FIELDS` Tool to list custom fields for a specified item class (accounts, contacts, or opportunities). Use when you need to retrieve available custom fields for an item type to understand what custom data can be stored or queried. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Filter custom fields by name. Returns custom fields whose name matches this value. | | `pipeline` | integer | No | Filter custom fields by pipeline ID. Only custom fields associated with the specified pipeline will be returned. | | `itemClass` | string ("accounts" | "contacts" | "opportunities") | Yes | The class of items to retrieve custom fields for. Must be one of: accounts, contacts, or opportunities. | | `includeDisabled` | boolean | No | Whether to include disabled custom fields in the response. If true, disabled fields are included; if false or omitted, only enabled fields are returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Custom Field Types **Slug:** `SALESFLARE_LIST_CUSTOM_FIELD_TYPES` Tool to retrieve a list of available custom field types in Salesflare. Use when you need to know which field types are supported for creating custom fields. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Email Data Sources **Slug:** `SALESFLARE_LIST_EMAIL_DATASOURCES` Tool to list email data sources. Use when you need to retrieve all email data sources associated with the user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include_team_datasources` | boolean | No | Team data sources will only be included when the session user is an admin. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Filter Fields **Slug:** `SALESFLARE_LIST_FILTER_FIELDS` Tool to list available filter fields for a specific entity type in Salesflare. Use when you need to retrieve the available filter fields for accounts, contacts, opportunities, or other entities. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entity` | string ("account" | "person" | "opportunity" | "campaign" | "tag" | "task" | "workflow" | "workflow_record" | "workflow_step_record" | "lead") | Yes | The entity type to retrieve filter fields for. Must be one of: account, person, opportunity, campaign, tag, task, workflow, workflow_record, workflow_step_record, lead. | | `pipeline` | integer | No | Optional pipeline ID to filter results by specific pipeline. | | `includePipelineSpecificPredefinedFilterFields` | boolean | No | Whether to include pipeline-specific predefined filter fields in the response. Defaults to true. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Groups **Slug:** `SALESFLARE_LIST_GROUPS` Tool to list groups in Salesflare. Use when you need to retrieve all groups in the team. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Contacts **Slug:** `SALESFLARE_LIST_MY_CONTACTS` Tool to list contacts belonging to the current user. Use when you need to retrieve, search, or filter contacts from Salesflare. Supports extensive filtering options including by name, email, phone, date ranges, tags, and custom fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Query string for advanced filtering. Use for complex search queries. | | `id` | array | No | Filter contacts by specific IDs. Provide a list of contact IDs to retrieve. | | `tag` | array | No | Filter contacts by tag IDs. Provide a list of tag IDs. | | `name` | string | No | Filter contacts by name. Partial matches are supported. | | `type` | string ("customer" | "mycontacts") | No | Contact type filter options. | | `email` | string | No | Filter contacts by email address. Partial matches are supported. | | `limit` | integer | No | Maximum number of contacts to return. Defaults to 20. | | `custom` | string | No | Filter by custom fields. Format depends on your custom field configuration. | | `domain` | string | No | Filter contacts by domain. Useful for finding contacts from specific companies. | | `export` | string | No | Export format for the contacts. Specify the desired export format. | | `offset` | integer | No | Number of contacts to skip for pagination. Defaults to 0. | | `search` | string | No | Search contacts by keyword. Searches across multiple fields like name, email, and company. | | `account` | array | No | Filter contacts by account IDs. Provide a list of account IDs. | | `order_by` | array | No | Order results by specified fields. Can be just 'key' (e.g., 'name') or 'key sortOrder' (e.g., 'name desc'). Defaults to ascending order. | | `tag.name` | array | No | Filter contacts by tag names. Provide a list of tag names. | | `address.city` | array | No | Filter contacts by city. Provide a list of city names. | | `phone_number` | string | No | Filter contacts by phone number. Partial matches are supported. | | `position.role` | array | No | Filter contacts by their position/role. Provide a list of role names. | | `creation_after` | string | No | Filter contacts created after this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). | | `address.country` | array | No | Filter contacts by country. Provide a list of country names or codes. | | `creation_before` | string | No | Filter contacts created before this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). | | `includeArchived` | boolean | No | Include archived contacts in the results. Set to true to include archived contacts. | | `modification_after` | string | No | Filter contacts modified after this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). | | `modification_before` | string | No | Filter contacts modified before this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). | | `address.state_region` | array | No | Filter contacts by state or region. Provide a list of state/region names. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Opportunities **Slug:** `SALESFLARE_LIST_OPPORTUNITIES` Tool to list opportunities with extensive filtering options. Use when you need to retrieve opportunities filtered by pipeline, stage, dates, value, tags, owner, account, or other criteria. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Advanced query filter as JSON string for complex filtering. | | `id` | integer | No | Filter by specific opportunity ID. | | `tag` | array | No | Filter by tag IDs (array of tag IDs). | | `done` | boolean | No | Filter by done status. True returns completed opportunities. | | `name` | string | No | Filter opportunities by exact name match. | | `limit` | integer | No | Maximum number of opportunities to return. Defaults to 10 if not specified. | | `owner` | integer | No | Filter by owner user ID. | | `stage` | integer | No | Filter by stage ID in the sales pipeline. | | `closed` | boolean | No | Filter by closed status. True returns closed opportunities, False returns open opportunities. | | `custom` | string | No | Custom field filters as JSON string. | | `export` | string | No | Export format if exporting opportunities. | | `offset` | integer | No | Number of opportunities to skip for pagination. | | `search` | string | No | Search term to filter opportunities by name or other text fields. | | `account` | integer | No | Filter by associated account ID. | | `details` | boolean | No | Include detailed information in the response. | | `hotness` | integer ("1" | "2" | "3") | No | Opportunity hotness level enum. | | `assignee` | integer | No | Filter by assignee user ID. | | `order_by` | array | No | Order results by specified fields. Can be 'field' (e.g., 'name') or 'field sortOrder' (e.g., 'name desc'). Defaults to asc. | | `pipeline` | integer | No | Filter by pipeline ID. | | `tag_name` | string | No | Filter by tag name. | | `max_value` | number | No | Maximum opportunity value for filtering. | | `min_value` | number | No | Minimum opportunity value for filtering. | | `stage_name` | string | No | Filter by stage name (e.g., 'Qualified', 'Proposal'). | | `close_after` | string | No | Filter opportunities with close date after this date (ISO 8601 format). | | `owner_group` | integer | No | Filter by owner group ID. | | `team_member` | integer | No | Filter by team member user ID. | | `close_before` | string | No | Filter opportunities with close date before this date (ISO 8601 format). | | `assignee_group` | integer | No | Filter by assignee group ID. | | `creation_after` | string | No | Filter opportunities created after this date (ISO 8601 format). | | `creation_before` | string | No | Filter opportunities created before this date (ISO 8601 format). | | `team_member_group` | integer | No | Filter by team member group ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Persons **Slug:** `SALESFLARE_LIST_PERSONS` Tool to list persons (non-contact people found in communications) from Salesflare. Use when you need to retrieve or search persons by name, email, ID, or keyword. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | Filter persons by specific IDs. Provide a list of person IDs to retrieve. | | `name` | string | No | Filter persons by name. Partial matches are supported. | | `email` | string | No | Filter persons by email address. Partial matches are supported. | | `search` | string | No | Search persons by keyword. Searches across multiple fields like name and email. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Pipelines **Slug:** `SALESFLARE_LIST_PIPELINES` Tool to list pipelines in the Salesflare system with filtering and sorting options. Use when you need to retrieve available pipelines for organizing opportunities and sales processes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Quick search query parameter for filtering pipelines. | | `search` | string | No | Search term to filter pipelines. Searches across pipeline name and other text fields. | | `order_by` | array | No | Sort order for results. Can be just 'key' (e.g., 'name') or 'key sortOrder' (e.g., 'name desc'). Defaults to ascending order if not specified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Stages **Slug:** `SALESFLARE_LIST_STAGES` Tool to list pipeline stages in the Salesflare system with filtering and sorting options. Use when you need to retrieve available stages for organizing opportunities in pipelines. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | No | Filter by stage ID. Returns the specific stage matching this ID. | | `name` | string | No | Filter by stage name. Searches for stages with names matching this value. | | `order_by` | string | No | Sort order for results. Can be just 'key' (e.g., 'name') or 'key sortOrder' (e.g., 'name desc'). Defaults to ascending order if not specified. | | `pipeline.id` | integer | No | Filter by pipeline ID. Returns stages belonging to the specified pipeline. | | `pipeline.name` | string | No | Filter by pipeline name. Returns stages belonging to pipelines with names matching this value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List tags **Slug:** `SALESFLARE_LIST_TAGS` Tool to list tags in the Salesflare system. Use when you need to retrieve tags with optional filtering by ID, name, or search query. Supports pagination and sorting for efficient tag retrieval. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | Filter tags by specific IDs. Provide a list of tag IDs to retrieve only those tags. | | `name` | string | No | Filter tags by name. Supports partial matching (e.g., 'Sales' will match 'Sales', 'Sales Automation', 'Sales Enablement'). | | `limit` | integer | No | Maximum number of tags to return. Defaults to 20 if not specified. | | `offset` | integer | No | Number of records to skip for pagination. Use with limit for paginated results. | | `order_by` | array | No | Sort order for results. Can be just 'key' (e.g., 'name') or 'key sortOrder' (e.g., 'name desc'). Defaults to ascending order if not specified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Tasks **Slug:** `SALESFLARE_LIST_TASKS` Tool to list tasks with filtering options. Use when you need to retrieve tasks filtered by type, assignee, dates, completion status, or associated accounts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Query string for advanced filtering. Use for complex search queries. | | `id` | array | No | Filter tasks by specific IDs. Provide a list of task IDs to retrieve. | | `type` | array | No | Filter tasks by type. Common types include 'call', 'email', 'meeting', 'todo', 'deadline', etc. | | `limit` | integer | No | Maximum number of tasks to return. Use for pagination. | | `export` | string | No | Export format for the tasks. Specify the desired export format. | | `offset` | integer | No | Number of tasks to skip for pagination. Defaults to 0. | | `search` | string | No | Search tasks by keyword. Searches across multiple fields like name and description. | | `account` | array | No | Filter tasks by associated account IDs. Provide a list of account IDs. | | `order_by` | array | No | Order results by specified fields. Can be just 'key' (e.g., 'name') or 'key sortOrder' (e.g., 'name desc'). Defaults to ascending order. | | `assignees` | array | No | Filter tasks by assignee user IDs. Defaults to the current user if not specified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Users **Slug:** `SALESFLARE_LIST_USERS` Tool to list users (team members) in the Salesflare team. Use when you need to retrieve team members, search for specific users, or filter users by various criteria. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | Filter users by specific IDs. Provide a list of user IDs to retrieve. | | `name` | string | No | Filter users by name. Partial matches are supported. | | `email` | string | No | Filter users by email address. Partial matches are supported. | | `limit` | integer | No | Maximum number of users to return. | | `offset` | integer | No | Number of users to skip for pagination. Use with limit for paginated results. | | `search` | string | No | Search users by keyword. Searches across multiple fields like name and email. | | `order_by` | array | No | Order results by specified fields. Can be just 'key' (e.g., 'name') or 'key sortOrder' (e.g., 'name desc'). Defaults to ascending order. | | `onlyEnabled` | boolean | No | Filter to show only enabled users. Set to true to exclude disabled users. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Workflows **Slug:** `SALESFLARE_LIST_WORKFLOWS` Tool to list workflows (email automation sequences) in Salesflare. Use when you need to retrieve or search for email automation workflows. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Advanced query filter as JSON string for complex filtering. | | `limit` | integer | No | Maximum number of workflows to return. Defaults to 20. | | `offset` | integer | No | Number of workflows to skip for pagination. Defaults to 0. | | `search` | string | No | Search term to filter workflows by name or other text fields. | | `order_by` | array | No | Order results by specified fields. Can be just 'key' (e.g., 'name') or 'key sortOrder' (e.g., 'name desc'). Defaults to ascending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Account **Slug:** `SALESFLARE_UPDATE_ACCOUNT` Tool to update an existing account in Salesflare. Use when you need to modify account details such as name, contact information, address, or custom fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Name of the account/company | | `size` | integer | No | Company size (number of employees) | | `tags` | array | No | List of tags to associate with the account | | `email` | string | No | Primary email address for the account | | `links` | string | No | Related links for the account | | `custom` | object | No | Custom field values as key-value pairs | | `domain` | string | No | Primary domain of the company | | `address` | object | No | Address information for an account. | | `picture` | string | No | URL to the account's logo or picture | | `website` | string | No | Company website URL | | `addresses` | array | No | List of addresses associated with the account | | `account_id` | integer | Yes | Unique identifier of the account to update | | `description` | string | No | Description of the account | | `phone_number` | string | No | Primary phone number for the account | | `phone_numbers` | array | No | List of phone numbers associated with the account | | `parent_account` | integer | No | ID of the parent account if this is a sub-account | | `email_addresses` | array | No | List of email addresses associated with the account | | `social_profiles` | array | No | List of social media profile URLs | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Account Contacts **Slug:** `SALESFLARE_UPDATE_ACCOUNT_CONTACTS` Tool to update the contacts associated with a specific Salesflare account. Use when you need to add, modify, or remove contact associations for an account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contacts` | array | Yes | Array of contact objects to update. Each object must contain an id field and optional _deleted and _dirty flags. | | `account_id` | integer | Yes | The ID of the account whose contacts will be updated. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Account Users **Slug:** `SALESFLARE_UPDATE_ACCOUNT_USERS` Tool to update the users associated with a specific Salesflare account. Use when you need to add, modify, or remove user associations for an account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `users` | array | Yes | Array of user objects to update. Each object must contain an id field and optional _deleted and _dirty flags. | | `account_id` | integer | Yes | The ID of the account whose users will be updated. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update AI Settings **Slug:** `SALESFLARE_UPDATE_AI_SETTINGS` Tool to update AI settings for the Salesflare team. Use when you need to configure AI context information for company or user profiles. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user` | object | No | User AI settings. | | `company` | object | No | Company AI settings. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Contact **Slug:** `SALESFLARE_UPDATE_CONTACT` Tool to update an existing contact in Salesflare. Use when you need to modify contact details such as name, email, phone, tags, or custom fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Full name of the contact. | | `role` | string | No | Job role or title of the contact. | | `tags` | array | No | List of tags to apply to the contact. | | `email` | string | No | Primary email address of the contact. | | `force` | boolean | No | When false, the contact's name will not be updated if the name in the update is just the first part of the email address. Default is true. | | `owner` | integer | No | User ID of the contact owner. | | `custom` | object | No | Custom fields as key-value pairs. | | `middle` | string | No | Middle name of the contact. | | `prefix` | string | No | Name prefix (e.g., 'Mr.', 'Ms.', 'Dr.'). | | `suffix` | string | No | Name suffix (e.g., 'Jr.', 'Sr.', 'III'). | | `account` | integer | No | Account ID to associate with the contact. Pass null to remove the existing account association. | | `address` | object | No | Address information for a contact | | `bounced` | boolean | No | Whether email to this contact has bounced. | | `opt-out` | boolean | No | Whether the contact has opted out of communications. | | `picture` | string | No | URL to the contact's picture. | | `archived` | boolean | No | Whether the contact is archived. | | `lastname` | string | No | Last name of the contact. | | `position` | object | No | Position information for a contact | | `addresses` | array | No | List of all addresses for the contact. | | `firstname` | string | No | First name of the contact. | | `positions` | array | No | List of all positions for the contact. | | `birth_date` | string | No | Birth date of the contact in ISO 8601 format (e.g., '1990-01-15T00:00:00Z'). | | `contact_id` | integer | Yes | The unique identifier of the contact to update (used in the URL path). | | `fax_number` | string | No | Fax number of the contact. | | `bounced_date` | string | No | Date when email bounced in ISO 8601 format. | | `opt-out_date` | string | No | Date when the contact opted out in ISO 8601 format. | | `phone_number` | string | No | Primary phone number of the contact. | | `phone_numbers` | array | No | List of all phone numbers for the contact. | | `social_profiles` | array | No | List of social media profile URLs. | | `opt-out_campaign` | string | No | Campaign from which the contact opted out. | | `home_phone_number` | string | No | Home phone number of the contact. | | `mobile_phone_number` | string | No | Mobile phone number of the contact. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Custom Field **Slug:** `SALESFLARE_UPDATE_CUSTOM_FIELD` Updates an existing custom field for accounts, contacts, or opportunities in Salesflare. Use when you need to modify the properties or settings of a custom field. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | ID of the custom field to update. | | `name` | string | No | Updated name of the custom field. | | `order` | integer | No | Display order of the custom field. | | `enabled` | boolean | No | Whether the custom field is enabled. | | `options` | array | No | List of options for select/multi-select type fields. | | `archived` | boolean | No | Whether the custom field is archived. | | `max_date` | string | No | Maximum date for date type fields in ISO 8601 format. | | `min_date` | string | No | Minimum date for date type fields in ISO 8601 format. | | `pipeline` | integer | No | Pipeline ID to associate with the custom field (for opportunities). | | `required` | boolean | No | Whether the custom field is required. | | `item_class` | string ("accounts" | "contacts" | "opportunities") | Yes | The entity type for which the custom field is being updated. Must be one of: accounts, contacts, or opportunities. | | `max_number` | number | No | Maximum value for number type fields. | | `min_number` | number | No | Minimum value for number type fields. | | `pipelineName` | string | No | Name of the pipeline associated with the custom field. | | `order_alphabetically` | boolean | No | Whether options should be ordered alphabetically. | | `users_can_add_options` | boolean | No | Whether users can add new options to select/multi-select fields. | | `predefined_customfield` | integer | No | ID of a predefined custom field template. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Email Data Source **Slug:** `SALESFLARE_UPDATE_EMAIL_DATASOURCE` Tool to update the settings of an email data source in Salesflare. Use when you need to modify email sending limits, signature settings, or signature content for a specific email data source. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The unique identifier of the email data source to update. | | `max_emails_day` | integer | No | Maximum number of emails to send per day. Must be between 0 and 2000. | | `email_signature` | string | No | The email signature text to be used. | | `max_emails_hour` | integer | No | Maximum number of emails to send per hour. Must be between 0 and 200. | | `add_signature_to_replies` | boolean | No | Whether to add email signature to reply emails. | | `add_signature_to_campaign` | boolean | No | Whether to add email signature to campaign emails. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Internal Note **Slug:** `SALESFLARE_UPDATE_INTERNAL_NOTE` Tool to update an existing internal note in Salesflare. Use when modifying the content or properties of an existing note. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Updated content of the internal note | | `date` | string | No | Date and time for the note in ISO 8601 format (e.g., '2024-01-15T10:30:00Z') | | `account` | integer | Yes | Account ID to associate the note with | | `mentions` | array | No | List of user IDs to mention in the note | | `message_id` | integer | Yes | ID of the internal note (message) to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Opportunity **Slug:** `SALESFLARE_UPDATE_OPPORTUNITY` Tool to update an existing opportunity in Salesflare. Use when you need to modify opportunity details such as name, value, stage, or other attributes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | REQUIRED. Unique identifier of the opportunity to update. | | `done` | boolean | No | Whether the opportunity is marked as done. Typically set when the deal is completed. | | `name` | string | No | Name/title of the opportunity (e.g., 'Q1 Enterprise Deal', 'Renewal Contract'). | | `tags` | array | No | List of tags to categorize the opportunity. | | `files` | array | No | List of file objects associated with the opportunity. | | `owner` | integer | No | User ID of the opportunity owner. Use GET_ME or LIST_USERS to find valid user IDs. | | `stage` | integer | No | Pipeline stage ID. Use LIST_STAGES to find valid stage IDs for your pipeline. | | `units` | number | No | Number of units for this opportunity (e.g., number of licenses, seats, or products). | | `value` | number | No | Total monetary value of the opportunity. Must be non-negative. | | `closed` | boolean | No | Whether the opportunity is closed. Set to true when the deal is won or lost. | | `custom` | object | No | Custom fields as key-value pairs. Use GET_CUSTOM_FIELDS to discover available custom field keys. | | `account` | integer | No | ID of the account (company) to associate this opportunity with. Use LIST_ACCOUNTS to find available account IDs. | | `creator` | integer | No | User ID of the person who created this opportunity. Typically set during creation, rarely updated. | | `assignee` | integer | No | User ID of the person assigned to this opportunity. Use GET_ME or LIST_USERS to find valid user IDs. | | `frequency` | string ("annually" | "weekly" | "monthly" | "daily") | No | Frequency type for recurring opportunities. | | `close_date` | string | No | Expected close date in ISO 8601 date-time format (e.g., '2024-12-31T23:59:59Z'). | | `start_date` | string | No | Opportunity start date in ISO 8601 date-time format. | | `lead_source` | integer | No | Lead source ID indicating where this opportunity originated. Use LIST_LEAD_SOURCES to find valid IDs. | | `lost_reason` | integer | No | Lost reason ID if the opportunity is marked as lost. Use LIST_LOST_REASONS to find valid IDs. | | `probability` | number | No | Win probability as a percentage (0-100). Higher values indicate greater likelihood of closing. | | `main_contact` | integer | No | Contact ID of the primary contact for this opportunity. Use LIST_CONTACTS to find valid contact IDs. | | `contract_end_date` | string | No | Contract end date in ISO 8601 date-time format. | | `contract_start_date` | string | No | Contract start date in ISO 8601 date-time format. | | `recurring_price_per_unit` | number | No | Recurring price per unit for subscription-based opportunities. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Tag **Slug:** `SALESFLARE_UPDATE_TAG` Tool to update the name of an existing tag in Salesflare. Use when you need to rename a tag. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The new name for the tag. | | `tag_id` | integer | Yes | The unique identifier of the tag to update (used in the URL path). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Task **Slug:** `SALESFLARE_UPDATE_TASK` Tool to update an existing task in Salesflare. Use when you need to modify task details such as description, completion status, assignees, or reminder date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | REQUIRED. Unique identifier of the task to update. | | `account` | integer | No | Account ID to associate with the task. Use LIST_ACCOUNTS to find available account IDs. | | `assignees` | array | No | List of user IDs assigned to this task. Use GET_CURRENT_USER or LIST_PERSONS to find valid user IDs. | | `completed` | boolean | No | Whether the task is completed. Set to true to mark the task as done. | | `description` | string | No | Description or details of the task. | | `reminder_date` | string | No | Reminder date for the task in ISO 8601 date format (e.g., '2024-12-31'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Workflow **Slug:** `SALESFLARE_UPDATE_WORKFLOW` Tool to update an existing workflow in Salesflare. Use when you need to modify workflow details such as name, status, steps, filters, or scheduling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | REQUIRED. Unique identifier of the workflow to update. | | `goal` | string ("opened" | "clicked" | "replied") | No | Goal for the workflow. | | `name` | string | Yes | REQUIRED. Name of the workflow. | | `steps` | array | No | List of steps in the workflow. Each step defines an action or trigger. | | `filter` | object | No | Filter for the workflow. | | `status` | string ("live" | "paused" | "scheduled" | "draft") | No | Status of the workflow. | | `continuous` | boolean | No | Whether the workflow runs continuously or is one-time only | | `record_type` | string ("contact") | No | Record type for the workflow. | | `schedule_date` | string | No | Scheduled start date for the workflow in ISO 8601 date-time format (e.g., '2024-12-31T23:59:59Z') | | `schedule_days` | array | No | Days of the week when the workflow can run (0=Sunday, 6=Saturday) | | `status_message` | string | No | Message associated with the workflow status | | `exit_after_days` | integer | No | Number of days after which contacts exit the workflow | | `schedule_time_end` | string | No | End time for daily workflow execution in HH:MM:SS format (e.g., '17:00:00') | | `schedule_time_start` | string | No | Start time for daily workflow execution in HH:MM:SS format (e.g., '09:00:00') | | `individual_record_filter` | object | No | Individual record filter for the workflow. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Workflow Audience **Slug:** `SALESFLARE_UPDATE_WORKFLOW_AUDIENCE` Tool to re-enter or exit an entity from a workflow in Salesflare. Use when you need to manage an entity's participation in a specific workflow, such as removing a contact from an automated email sequence or re-adding them after they exited. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Unique identifier of the workflow. Use LIST_WORKFLOWS to find valid workflow IDs. | | `exited` | boolean | No | 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` | boolean | No | Setting 'met_goal' to true marks that the workflow goal was achieved. Note: Setting 'met_goal' to false is currently not possible. | | `record_id` | integer | Yes | The entity ID to re-enter or exit from the workflow. For email workflows this should be the contact ID. Use LIST_CONTACTS or LIST_ACCOUNTS to find valid entity IDs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |