Skip to main content
Salesflare logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 63
  • Triggers: 0
  • Slug: SALESFLARE
  • Version: 20261101_00

Tools

Slug: SALESFLARE_ADD_ACCOUNT_CONTACTSTool to add contacts to a specific account in Salesflare. Use when you need to link existing contacts to an account.

Input Parameters

array
required
List of contact objects to add to the account. Each object must contain a contact ID.
integer
required
The unique ID of the account to add contacts to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_CREATE_ACCOUNTTool 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

string
Name of the account/company. This is the primary identifier for the account.
integer
Company size (number of employees)
array
List of tags for categorizing the account
string
Primary email address for the account
Additional links related to the account
integer
User ID of the account owner in Salesflare
object
Custom fields as key-value pairs. Keys should match custom field names defined in your Salesflare account. Values can be strings, numbers, or booleans.
string
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.
string
URL to company logo or picture
string
Company website URL
array
List of addresses associated with the account
array
List of customers associated with this account
string
Description or notes about the account
string
Primary phone number for the account
array
List of phone numbers associated with the account
integer
ID of the parent account if this is a subsidiary or child account
array
List of email addresses associated with the account
array
List of social media profile URLs (LinkedIn, Twitter, etc.)
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_CREATE_CALLTool 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

array
required
List of call records to create. Each call must have a date and participants list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_CREATE_CONTACTTool 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

boolean
When false, the contact will not be created if a contact with the same email address used to exist. Defaults to true.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_CREATE_CUSTOM_FIELDCreates 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

string
Name of the custom field.
integer
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.
boolean
Whether the custom field is enabled.
array
List of options for select/multi-select type fields.
boolean
Whether the custom field is archived.
string
Maximum date for date type fields in ISO 8601 format.
string
Minimum date for date type fields in ISO 8601 format.
integer
Pipeline ID to associate with the custom field (for opportunities).
boolean
Whether the custom field is required.
string ("accounts" | "contacts" | "opportunities")
required
The entity type for which the custom field is created. Must be one of: accounts, contacts, or opportunities.
number
Maximum value for number type fields.
number
Minimum value for number type fields.
boolean
Whether options should be ordered alphabetically. Default is false.
boolean
Default value for boolean/checkbox type fields.
boolean
Whether users can add new options to select/multi-select fields.
integer
ID of a predefined custom field template to use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_CREATE_INTERNAL_NOTETool 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

string
required
Content of the internal note
string
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.
integer
required
Account ID to associate the internal note with
array
List of user IDs to mention in the note

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_CREATE_MEETINGCreate 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

string
required
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.
string ("meeting-live" | "meeting-phone")
Type of meeting
string
Meeting notes or minutes. Use this field to record what was discussed or decided during the meeting.
string
DEPRECATED: Use the ‘notes’ property instead. Meeting minutes recorded after the meeting.
string
Subject or title of the meeting. Maximum 200 characters. This will be the displayed name of the meeting.
string
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.
string
Type of phone call (e.g., ‘inbound’, ‘outbound’). Relevant when type is ‘meeting-phone’.
string
Detailed description or notes about the meeting. Provides additional context about the meeting agenda or outcomes.
array
required
List of participant IDs (Salesflare contact IDs) attending the meeting. At least one participant is required unless it’s a call log sync.
string
Phone number hash for call log synchronization. Used when syncing call logs from external systems.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_CREATE_OPPORTUNITYTool 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

string
Name/title of the opportunity (e.g., ‘Q1 Enterprise Deal’, ‘Renewal Contract’). If not provided, may be auto-generated by Salesflare.
array
List of tags to categorize the opportunity.
integer
User ID of the opportunity owner. Use GET_ME or LIST_USERS to find valid user IDs.
integer
Pipeline stage ID. Use LIST_STAGES to find valid stage IDs for your pipeline.
number
Number of units for this opportunity (e.g., number of licenses, seats, or products).
number
Total monetary value of the opportunity. Must be non-negative.
boolean
Whether the opportunity is closed. Set to true when the deal is won or lost.
object
Custom fields as key-value pairs. Use GET_CUSTOM_FIELDS to discover available custom field keys.
integer
required
REQUIRED. ID of the account (company) to associate this opportunity with. Use LIST_ACCOUNTS to find available account IDs.
integer
User ID of the person who created this opportunity. Defaults to the authenticated user if not specified.
integer
User ID of the person assigned to this opportunity. Use GET_ME or LIST_USERS to find valid user IDs.
integer
Currency ID for the opportunity value. Use LIST_CURRENCIES to find valid currency IDs.
string ("annually" | "weekly" | "monthly" | "daily")
Frequency type for recurring opportunities.
string
Expected close date in ISO 8601 date-time format (e.g., ‘2024-12-31T23:59:59Z’).
string
Opportunity start date in ISO 8601 date-time format.
integer
Lead source ID indicating where this opportunity originated. Use LIST_LEAD_SOURCES to find valid IDs.
integer
Lost reason ID if the opportunity is marked as lost. Use LIST_LOST_REASONS to find valid IDs.
number
Win probability as a percentage (0-100). Higher values indicate greater likelihood of closing.
integer
Contact ID of the primary contact for this opportunity. Use LIST_CONTACTS to find valid contact IDs.
string
Contract end date in ISO 8601 date-time format.
string
Contract start date in ISO 8601 date-time format.
number
Recurring price per unit for subscription-based opportunities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_CREATE_TAGTool to create a new tag in Salesflare. Use when you need to add a new tag for categorizing accounts, contacts, or opportunities.

Input Parameters

string
required
Name of the tag to create. Use descriptive names to categorize accounts, contacts, or opportunities effectively.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_CREATE_TASKTool 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

integer
ID of the account (company) to associate this task with. Use LIST_ACCOUNTS to find available account IDs.
array
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.
string
required
REQUIRED. Description or title of the task. This is the main content describing what needs to be done.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_CREATE_WORKFLOWTool 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

string ("opened" | "clicked" | "replied")
Goal types for workflow completion.
string
required
Name of the workflow. This is the only required field.
array
List of steps in the workflow sequence. Each step must have an ‘order’ field.
object
Filter configuration for workflow targeting.
string ("live" | "paused" | "scheduled" | "draft")
Status options for workflow.
boolean
Whether the workflow runs continuously or only once per record
string ("contact")
Record type for workflow targets.
string
Date and time to start the workflow in ISO 8601 format (e.g., ‘2024-12-31T10:00:00Z’)
array
Days of the week to run the workflow (0=Sunday, 1=Monday, …, 6=Saturday)
string
Status message or notes about the workflow
number
Number of days after which records automatically exit the workflow
string
End time for daily workflow execution in HH:MM:SS format (e.g., ‘17:00:00’)
string
Start time for daily workflow execution in HH:MM:SS format (e.g., ‘09:00:00’)
object
Advanced filtering configuration for individual records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_DELETE_ACCOUNTTool 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

integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_DELETE_CONTACTTool to delete a contact from Salesflare. Use when you need to remove a contact by their unique identifier after confirming this detail.

Input Parameters

integer
required
Unique identifier of the contact to delete from Salesflare.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_DELETE_CUSTOM_FIELDTool 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

integer
required
The unique numeric ID of the custom field to delete.
string ("accounts" | "contacts" | "opportunities")
required
The type of entity the custom field belongs to. Must be one of: accounts, contacts, or opportunities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_DELETE_INTERNAL_NOTETool 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

integer
required
Unique identifier of the internal note (message) to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_DELETE_MEETINGTool to delete a meeting from Salesflare. Use when you need to remove a meeting from the system.

Input Parameters

integer
required
The unique identifier of the meeting to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_DELETE_OPPORTUNITYTool 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

integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_DELETE_TAGTool to delete a tag from Salesflare. Use when you need to remove a tag from the system.

Input Parameters

integer
required
The unique identifier of the tag to delete from the Salesflare system

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_DELETE_TASKTool to delete a task from Salesflare. Use when you need to remove a task from the system.

Input Parameters

integer
required
The unique identifier of the task to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_ACCOUNTGet 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

integer
required
Unique identifier of the account to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_AI_SETTINGSTool to retrieve AI settings for the Salesflare team. Use when you need to check the current AI configuration for company and user profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_CONTACTRetrieves 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

integer
required
Unique numeric identifier of the contact to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_CURRENT_USERTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_CUSTOM_FIELDTool 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

integer
required
The unique identifier of the custom field to retrieve
string ("accounts" | "contacts" | "opportunities")
required
The class of item the custom field belongs to (accounts, contacts, or opportunities)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_MEETINGTool 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

integer
required
The unique identifier of the meeting to retrieve. Must be a valid meeting ID from Salesflare.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_OPPORTUNITYGet detailed information about a specific Salesflare opportunity by ID, including its account, main contact, pipeline stage, value, dates, and other available metadata.

Input Parameters

integer
required
Unique identifier of the opportunity to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_STAGEGet 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

integer
required
Unique identifier of the pipeline stage to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_TAG_USAGEGet 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

integer
required
Unique identifier of the tag to retrieve usage information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_USERTool 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

integer
required
Unique identifier of the user to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_WORKFLOWGet 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

integer
required
Unique identifier of the workflow to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_GET_WORKFLOW_MERGE_FIELDSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_ACCOUNT_MESSAGESTool 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

string
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.
integer
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.
string
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.
integer
required
The unique identifier of the account whose messages you want to retrieve. This is a numeric ID representing the account in Salesflare.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_ACCOUNTSTool 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

string
Quick search query parameter for filtering accounts.
array
Filter accounts by specific IDs. Provide a list of account IDs to retrieve only those accounts.
array
Filter accounts by tag IDs. Provide a list of tag IDs to filter accounts that have these tags.
string
Filter accounts by exact or partial name match.
integer
Maximum number of accounts to return. Defaults to 10 if not specified.
string
Custom filter query for advanced filtering. Consult API documentation for syntax.
array
Filter accounts by domain names. Provide a list of domains to match.
string
Export format if requesting data export. Consult API documentation for supported formats.
integer
Number of records to skip for pagination. Use with limit for paginated results.
Search term to filter accounts. Searches across account name, domain, and other text fields.
boolean
Whether to include detailed account information in the response. Defaults to true.
integer ("1" | "2" | "3")
Hotness level enumeration: 1: Room temp, 2: Hot, 3: On fire
integer
Filter accounts with a maximum company size (number of employees).
integer
Filter accounts with a minimum company size (number of employees).
array
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.
array
Filter accounts by tag names. Provide a list of tag names to filter accounts.
array
Filter accounts by city. Provide a list of city names.
string
Filter accounts created after this date. Use ISO 8601 format (YYYY-MM-DD or full timestamp).
array
Filter accounts by country. Provide a list of country names or codes.
string
Filter accounts created before this date. Use ISO 8601 format (YYYY-MM-DD or full timestamp).
array
Filter accounts by state or region. Provide a list of state/region names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_CONTACTSTool 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

string
Query string for advanced filtering. Use for complex search queries.
array
Filter contacts by specific IDs. Provide a list of contact IDs to retrieve.
array
Filter contacts by tag IDs. Provide a list of tag IDs.
string
Filter contacts by name. Partial matches are supported.
string ("customer" | "mycontacts")
Contact type filter options.
string
Filter contacts by email address. Partial matches are supported.
integer
Maximum number of contacts to return. Defaults to 20.
string
Filter by custom fields. Format depends on your custom field configuration.
string
Filter contacts by domain. Useful for finding contacts from specific companies.
string
Export format for the contacts. Specify the desired export format.
integer
Number of contacts to skip for pagination. Defaults to 0.
string
Search contacts by keyword. Searches across multiple fields like name, email, and company.
array
Filter contacts by account IDs. Provide a list of account IDs.
array
Order results by specified fields. Can be just ‘key’ (e.g., ‘name’) or ‘key sortOrder’ (e.g., ‘name desc’). Defaults to ascending order.
array
Filter contacts by tag names. Provide a list of tag names.
array
Filter contacts by city. Provide a list of city names.
string
Filter contacts by phone number. Partial matches are supported.
array
Filter contacts by their position/role. Provide a list of role names.
string
Filter contacts created after this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
array
Filter contacts by country. Provide a list of country names or codes.
string
Filter contacts created before this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
boolean
Include archived contacts in the results. Set to true to include archived contacts.
string
Filter contacts modified after this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
string
Filter contacts modified before this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
array
Filter contacts by state or region. Provide a list of state/region names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_CURRENCIESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_CUSTOM_FIELD_OPTIONSLists option names for a specific Salesflare custom field, with optional search-string filtering. Supports select or multi-select custom fields.

Input Parameters

string ("accounts" | "contacts" | "opportunities")
required
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).
string
Optional search string to filter the options. Only options matching this search string will be returned.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_CUSTOM_FIELDSTool 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

string
Filter custom fields by name. Returns custom fields whose name matches this value.
integer
Filter custom fields by pipeline ID. Only custom fields associated with the specified pipeline will be returned.
string ("accounts" | "contacts" | "opportunities")
required
The class of items to retrieve custom fields for. Must be one of: accounts, contacts, or opportunities.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_CUSTOM_FIELD_TYPESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_EMAIL_DATASOURCESTool to list email data sources. Use when you need to retrieve all email data sources associated with the user.

Input Parameters

boolean
Team data sources will only be included when the session user is an admin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_FILTER_FIELDSTool 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

string ("account" | "person" | "opportunity" | "campaign" | "tag" | "task" | "workflow" | "workflow_record" | "workflow_step_record" | "lead")
required
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.
integer
Optional pipeline ID to filter results by specific pipeline.
boolean
Whether to include pipeline-specific predefined filter fields in the response. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_GROUPSTool to list groups in Salesflare. Use when you need to retrieve all groups in the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_MY_CONTACTSTool 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

string
Query string for advanced filtering. Use for complex search queries.
array
Filter contacts by specific IDs. Provide a list of contact IDs to retrieve.
array
Filter contacts by tag IDs. Provide a list of tag IDs.
string
Filter contacts by name. Partial matches are supported.
string ("customer" | "mycontacts")
Contact type filter options.
string
Filter contacts by email address. Partial matches are supported.
integer
Maximum number of contacts to return. Defaults to 20.
string
Filter by custom fields. Format depends on your custom field configuration.
string
Filter contacts by domain. Useful for finding contacts from specific companies.
string
Export format for the contacts. Specify the desired export format.
integer
Number of contacts to skip for pagination. Defaults to 0.
string
Search contacts by keyword. Searches across multiple fields like name, email, and company.
array
Filter contacts by account IDs. Provide a list of account IDs.
array
Order results by specified fields. Can be just ‘key’ (e.g., ‘name’) or ‘key sortOrder’ (e.g., ‘name desc’). Defaults to ascending order.
array
Filter contacts by tag names. Provide a list of tag names.
array
Filter contacts by city. Provide a list of city names.
string
Filter contacts by phone number. Partial matches are supported.
array
Filter contacts by their position/role. Provide a list of role names.
string
Filter contacts created after this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
array
Filter contacts by country. Provide a list of country names or codes.
string
Filter contacts created before this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
boolean
Include archived contacts in the results. Set to true to include archived contacts.
string
Filter contacts modified after this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
string
Filter contacts modified before this date. Use ISO 8601 date format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
array
Filter contacts by state or region. Provide a list of state/region names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_OPPORTUNITIESTool 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

string
Advanced query filter as JSON string for complex filtering.
integer
Filter by specific opportunity ID.
array
Filter by tag IDs (array of tag IDs).
boolean
Filter by done status. True returns completed opportunities.
string
Filter opportunities by exact name match.
integer
Maximum number of opportunities to return. Defaults to 10 if not specified.
integer
Filter by owner user ID.
integer
Filter by stage ID in the sales pipeline.
boolean
Filter by closed status. True returns closed opportunities, False returns open opportunities.
string
Custom field filters as JSON string.
string
Export format if exporting opportunities.
integer
Number of opportunities to skip for pagination.
string
Search term to filter opportunities by name or other text fields.
integer
Filter by associated account ID.
boolean
Include detailed information in the response.
integer ("1" | "2" | "3")
Opportunity hotness level enum.
integer
Filter by assignee user ID.
array
Order results by specified fields. Can be ‘field’ (e.g., ‘name’) or ‘field sortOrder’ (e.g., ‘name desc’). Defaults to asc.
integer
Filter by pipeline ID.
string
Filter by tag name.
number
Maximum opportunity value for filtering.
number
Minimum opportunity value for filtering.
string
Filter by stage name (e.g., ‘Qualified’, ‘Proposal’).
string
Filter opportunities with close date after this date (ISO 8601 format).
integer
Filter by owner group ID.
integer
Filter by team member user ID.
string
Filter opportunities with close date before this date (ISO 8601 format).
integer
Filter by assignee group ID.
string
Filter opportunities created after this date (ISO 8601 format).
string
Filter opportunities created before this date (ISO 8601 format).
integer
Filter by team member group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_PERSONSTool 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

array
Filter persons by specific IDs. Provide a list of person IDs to retrieve.
string
Filter persons by name. Partial matches are supported.
string
Filter persons by email address. Partial matches are supported.
string
Search persons by keyword. Searches across multiple fields like name and email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_PIPELINESList Salesflare pipelines with optional search filters and sorting. Use the results to find available pipelines for organizing opportunities and sales processes.

Input Parameters

string
Quick search query parameter for filtering pipelines.
string
Search term to filter pipelines. Searches across pipeline name and other text fields.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_STAGESList Salesflare pipeline stages with filtering and sorting options. An unexpected response format may be returned as an empty stage list.

Input Parameters

integer
Filter by stage ID. Returns the specific stage matching this ID.
string
Filter by stage name. Searches for stages with names matching this value.
string
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.
integer
Filter by pipeline ID. Returns stages belonging to the specified pipeline.
string
Filter by pipeline name. Returns stages belonging to pipelines with names matching this value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_TAGSList Salesflare tags with optional ID or name filtering, pagination, and sorting.

Input Parameters

array
Filter tags by specific IDs. Provide a list of tag IDs to retrieve only those tags.
string
Filter tags by name. Supports partial matching (e.g., ‘Sales’ will match ‘Sales’, ‘Sales Automation’, ‘Sales Enablement’).
integer
Maximum number of tags to return. Defaults to 20 if not specified.
integer
Number of records to skip for pagination. Use with limit for paginated results.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_TASKSTool 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

string
Query string for advanced filtering. Use for complex search queries.
array
Filter tasks by specific IDs. Provide a list of task IDs to retrieve.
array
Filter tasks by type. Common types include ‘call’, ‘email’, ‘meeting’, ‘todo’, ‘deadline’, etc.
integer
Maximum number of tasks to return. Use for pagination.
string
Export format for the tasks. Specify the desired export format.
integer
Number of tasks to skip for pagination. Defaults to 0.
string
Search tasks by keyword. Searches across multiple fields like name and description.
array
Filter tasks by associated account IDs. Provide a list of account IDs.
array
Order results by specified fields. Can be just ‘key’ (e.g., ‘name’) or ‘key sortOrder’ (e.g., ‘name desc’). Defaults to ascending order.
array
Filter tasks by assignee user IDs. Defaults to the current user if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_USERSTool 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

array
Filter users by specific IDs. Provide a list of user IDs to retrieve.
string
Filter users by name. Partial matches are supported.
string
Filter users by email address. Partial matches are supported.
integer
Maximum number of users to return.
integer
Number of users to skip for pagination. Use with limit for paginated results.
string
Search users by keyword. Searches across multiple fields like name and email.
array
Order results by specified fields. Can be just ‘key’ (e.g., ‘name’) or ‘key sortOrder’ (e.g., ‘name desc’). Defaults to ascending order.
boolean
Filter to show only enabled users. Set to true to exclude disabled users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_LIST_WORKFLOWSTool to list workflows (email automation sequences) in Salesflare. Use when you need to retrieve or search for email automation workflows.

Input Parameters

string
Advanced query filter as JSON string for complex filtering.
integer
Maximum number of workflows to return. Defaults to 20.
integer
Number of workflows to skip for pagination. Defaults to 0.
string
Search term to filter workflows by name or other text fields.
array
Order results by specified fields. Can be just ‘key’ (e.g., ‘name’) or ‘key sortOrder’ (e.g., ‘name desc’). Defaults to ascending order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_ACCOUNTTool 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

string
Name of the account/company
integer
Company size (number of employees)
array
List of tags to associate with the account
string
Primary email address for the account
Related links for the account
object
Custom field values as key-value pairs
string
Primary domain of the company
object
Address information for an account.
string
URL to the account’s logo or picture
string
Company website URL
array
List of addresses associated with the account
integer
required
Unique identifier of the account to update
string
Description of the account
string
Primary phone number for the account
array
List of phone numbers associated with the account
integer
ID of the parent account if this is a sub-account
array
List of email addresses associated with the account
array
List of social media profile URLs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_ACCOUNT_CONTACTSTool 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

array
required
Array of contact objects to update. Each object must contain an id field and optional _deleted and _dirty flags.
integer
required
The ID of the account whose contacts will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_ACCOUNT_USERSTool 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

array
required
Array of user objects to update. Each object must contain an id field and optional _deleted and _dirty flags.
integer
required
The ID of the account whose users will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_AI_SETTINGSTool to update AI settings for the Salesflare team. Use when you need to configure AI context information for company or user profiles.

Input Parameters

object
User AI settings.
object
Company AI settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_CONTACTTool 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

string
Full name of the contact.
string
Job role or title of the contact.
array
List of tags to apply to the contact.
string
Primary email address of the contact.
boolean
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.
integer
User ID of the contact owner.
object
Custom fields as key-value pairs.
string
Middle name of the contact.
string
Name prefix (e.g., ‘Mr.’, ‘Ms.’, ‘Dr.’).
string
Name suffix (e.g., ‘Jr.’, ‘Sr.’, ‘III’).
integer
Account ID to associate with the contact. Pass null to remove the existing account association.
object
Address information for a contact
boolean
Whether email to this contact has bounced.
boolean
Whether the contact has opted out of communications.
string
URL to the contact’s picture.
boolean
Whether the contact is archived.
string
Last name of the contact.
object
Position information for a contact
array
List of all addresses for the contact.
string
First name of the contact.
array
List of all positions for the contact.
string
Birth date of the contact in ISO 8601 format (e.g., ‘1990-01-15T00:00:00Z’).
integer
required
The unique identifier of the contact to update (used in the URL path).
string
Fax number of the contact.
string
Date when email bounced in ISO 8601 format.
string
Date when the contact opted out in ISO 8601 format.
string
Primary phone number of the contact.
array
List of all phone numbers for the contact.
array
List of social media profile URLs.
string
Campaign from which the contact opted out.
string
Home phone number of the contact.
string
Mobile phone number of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_CUSTOM_FIELDUpdates 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

integer
required
ID of the custom field to update.
string
Updated name of the custom field.
integer
Display order of the custom field.
boolean
Whether the custom field is enabled.
array
List of options for select/multi-select type fields.
boolean
Whether the custom field is archived.
string
Maximum date for date type fields in ISO 8601 format.
string
Minimum date for date type fields in ISO 8601 format.
integer
Pipeline ID to associate with the custom field (for opportunities).
boolean
Whether the custom field is required.
string ("accounts" | "contacts" | "opportunities")
required
The entity type for which the custom field is being updated. Must be one of: accounts, contacts, or opportunities.
number
Maximum value for number type fields.
number
Minimum value for number type fields.
string
Name of the pipeline associated with the custom field.
boolean
Whether options should be ordered alphabetically.
boolean
Whether users can add new options to select/multi-select fields.
integer
ID of a predefined custom field template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_EMAIL_DATASOURCETool 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

integer
required
The unique identifier of the email data source to update.
integer
Maximum number of emails to send per day. Must be between 0 and 2000.
string
The email signature text to be used.
integer
Maximum number of emails to send per hour. Must be between 0 and 200.
boolean
Whether to add email signature to reply emails.
boolean
Whether to add email signature to campaign emails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_INTERNAL_NOTETool to update an existing internal note in Salesflare. Use when modifying the content or properties of an existing note.

Input Parameters

string
required
Updated content of the internal note
string
Date and time for the note in ISO 8601 format (e.g., ‘2024-01-15T10:30:00Z’)
integer
required
Account ID to associate the note with
array
List of user IDs to mention in the note
integer
required
ID of the internal note (message) to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_OPPORTUNITYTool 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

integer
required
REQUIRED. Unique identifier of the opportunity to update.
boolean
Whether the opportunity is marked as done. Typically set when the deal is completed.
string
Name/title of the opportunity (e.g., ‘Q1 Enterprise Deal’, ‘Renewal Contract’).
array
List of tags to categorize the opportunity.
array
List of file objects associated with the opportunity.
integer
User ID of the opportunity owner. Use GET_ME or LIST_USERS to find valid user IDs.
integer
Pipeline stage ID. Use LIST_STAGES to find valid stage IDs for your pipeline.
number
Number of units for this opportunity (e.g., number of licenses, seats, or products).
number
Total monetary value of the opportunity. Must be non-negative.
boolean
Whether the opportunity is closed. Set to true when the deal is won or lost.
object
Custom fields as key-value pairs. Use GET_CUSTOM_FIELDS to discover available custom field keys.
integer
ID of the account (company) to associate this opportunity with. Use LIST_ACCOUNTS to find available account IDs.
integer
User ID of the person who created this opportunity. Typically set during creation, rarely updated.
integer
User ID of the person assigned to this opportunity. Use GET_ME or LIST_USERS to find valid user IDs.
string ("annually" | "weekly" | "monthly" | "daily")
Frequency type for recurring opportunities.
string
Expected close date in ISO 8601 date-time format (e.g., ‘2024-12-31T23:59:59Z’).
string
Opportunity start date in ISO 8601 date-time format.
integer
Lead source ID indicating where this opportunity originated. Use LIST_LEAD_SOURCES to find valid IDs.
integer
Lost reason ID if the opportunity is marked as lost. Use LIST_LOST_REASONS to find valid IDs.
number
Win probability as a percentage (0-100). Higher values indicate greater likelihood of closing.
integer
Contact ID of the primary contact for this opportunity. Use LIST_CONTACTS to find valid contact IDs.
string
Contract end date in ISO 8601 date-time format.
string
Contract start date in ISO 8601 date-time format.
number
Recurring price per unit for subscription-based opportunities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_TAGTool to update the name of an existing tag in Salesflare. Use when you need to rename a tag.

Input Parameters

string
required
The new name for the tag.
integer
required
The unique identifier of the tag to update (used in the URL path).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_TASKTool 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

integer
required
REQUIRED. Unique identifier of the task to update.
integer
Account ID to associate with the task. Use LIST_ACCOUNTS to find available account IDs.
array
List of user IDs assigned to this task. Use GET_CURRENT_USER or LIST_PERSONS to find valid user IDs.
boolean
Whether the task is completed. Set to true to mark the task as done.
string
Description or details of the task.
string
Reminder date for the task in ISO 8601 date format (e.g., ‘2024-12-31’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_WORKFLOWTool 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

integer
required
REQUIRED. Unique identifier of the workflow to update.
string ("opened" | "clicked" | "replied")
Goal for the workflow.
string
required
REQUIRED. Name of the workflow.
array
List of steps in the workflow. Each step defines an action or trigger.
object
Filter for the workflow.
string ("live" | "paused" | "scheduled" | "draft")
Status of the workflow.
boolean
Whether the workflow runs continuously or is one-time only
string ("contact")
Record type for the workflow.
string
Scheduled start date for the workflow in ISO 8601 date-time format (e.g., ‘2024-12-31T23:59:59Z’)
array
Days of the week when the workflow can run (0=Sunday, 6=Saturday)
string
Message associated with the workflow status
integer
Number of days after which contacts exit the workflow
string
End time for daily workflow execution in HH:MM:SS format (e.g., ‘17:00:00’)
string
Start time for daily workflow execution in HH:MM:SS format (e.g., ‘09:00:00’)
object
Individual record filter for the workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFLARE_UPDATE_WORKFLOW_AUDIENCEUpdate an entity’s participation in a Salesflare workflow, including exiting or re-entering it and marking the workflow goal as met.

Input Parameters

integer
required
Unique identifier of the workflow. Use LIST_WORKFLOWS to find valid workflow IDs.
boolean
Setting ‘exited’ to true will exit the entity from the workflow. Setting ‘exited’ to false will re-enter the entity into the workflow.
boolean
Setting ‘met_goal’ to true marks that the workflow goal was achieved. Note: Setting ‘met_goal’ to false is currently not possible.
integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not