> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Salesflare

The Salesflare connector lets your AI agent act in each user's Salesflare account. Each user connects their own Salesflare access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.

**Authentication:** Bearer Token
**Categories:** CRM & Sales
**Tools:** 59: 31 read, 20 write, 8 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=SALESFLARE)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Salesflare connection

   In **AgentKit > Connections**, create a Salesflare connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'salesflare'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Salesflare:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'salesflare_accounts_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "salesflare"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Salesflare:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="salesflare_accounts_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Salesflare credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'salesflare_account_feed_get',
  toolInput: {
    account_id: 45678,
  },
  connector: 'salesflare',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="salesflare_account_feed_get",
    tool_input={
        "account_id": 45678,
    },
    connection_name="salesflare",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `salesflare_account_feed_get`

Get Account Feed · Read-only

Get the activity timeline of an account: emails, internal notes, meetings, calls, web visits and team changes, optionally filtered by type, contacts or date. Returns feed items with type, date, participants and content. Use this for a full history. Use salesflare_account_messages_list for emails only.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account_id` (`integer`, required): Salesflare ID of the account. Example: 45678.
- `after` (`string`, optional): Only items after this ISO 8601 date-time. Defaults to 1970-01-01T00:00:00.000Z. Example: 2026-01-01T00:00:00Z.
- `before` (`string`, optional): Only items before this ISO 8601 date-time. Example: 2026-06-30T23:59:59Z.
- `contacts` (`array`, optional): Contact IDs to filter the feed on; leave empty for all contacts. Example: [56789]
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 10. Example: 25.
- `types` (`array`, optional): Feed item types to include. Example: ["email","meeting-live"]

Example input: `{"account_id":45678}`

### `salesflare_account_get`

Get Account · Read-only

Get one account by ID. Returns its name, domain, size, description, addresses, email addresses, phone numbers, social profiles, tags, owner, team and custom fields. Use this when you know the account ID. Use salesflare_accounts_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account_id` (`integer`, required): Salesflare ID of the account. Example: 45678.

Example input: `{"account_id":45678}`

### `salesflare_account_messages_list`

List Account Messages · Read-only

List the email messages exchanged with an account, optionally within a date range. Returns message ID, subject, body preview, sender, recipients and date. Use this to read correspondence. Use salesflare_account_feed_get for all activity types.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account_id` (`integer`, required): Salesflare ID of the account. Example: 45678.
- `after` (`string`, optional): Only items after this ISO 8601 date-time. Defaults to 1970-01-01T00:00:00.000Z. Example: 2026-01-01T00:00:00Z.
- `before` (`string`, optional): Only items before this ISO 8601 date-time. Example: 2026-06-30T23:59:59Z.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 10. Example: 25.

Example input: `{"account_id":45678}`

### `salesflare_accounts_list`

List Accounts · Read-only

List accounts (companies), filtered by name, search text, domain, size, tag, address, hotness or creation date. Returns account ID, name, domain, size, hotness, owner and last interaction; set details to true for addresses, phones and custom fields. Use this to find accounts. Use salesflare_account_get for one account by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `address_city` (`array`, optional): Filter by address city. Example: Ghent.
- `address_country` (`array`, optional): Filter by address country. Example: Belgium.
- `address_state_region` (`array`, optional): Filter by address state or region. Example: East Flanders.
- `creation_after` (`string`, optional): Only records created after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `creation_before` (`string`, optional): Only records created before this ISO 8601 date-time. Example: 2026-06-30T23:59:59Z.
- `details` (`boolean`, optional): Set to true to include full details (addresses, phone numbers, social profiles and custom fields) for each record. Defaults to true. Example: true.
- `domain` (`array`, optional): Filter by website domain, without protocol. Example: acme.com.
- `hotness` (`integer`, optional): Hotness level: 1 (room temperature), 2 (hot) or 3 (on fire). One of: 1, 2, 3. Example: 2.
- `id` (`integer`, optional): Return only the record with this Salesflare ID. Example: 12345.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 10. Example: 25.
- `max_size` (`integer`, optional): Only accounts with at most this many employees. Example: 500.
- `min_size` (`integer`, optional): Only accounts with at least this many employees. Example: 10.
- `name` (`string`, optional): Filter by name (exact or partial match). Example: Acme.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `order_by` (`array`, optional): Sort field; add ' desc' for descending order, e.g. 'creation_date desc'. Example: creation_date desc.
- `search` (`string`, optional): Free-text search across names, email addresses and domains. Example: acme.
- `tag` (`integer`, optional): Filter by tag ID. Example: 321.
- `tag_name` (`array`, optional): Filter by tag name. Example: enterprise.

Example input: `{}`

### `salesflare_contact_get`

Get Contact · Read-only

Get one contact by ID. Returns name, emails, phone numbers, positions, addresses, account, owner, tags, social profiles and custom fields. Use this when you know the contact ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`integer`, required): Salesflare ID of the contact. Example: 56789.

Example input: `{"contact_id":56789}`

### `salesflare_contacts_list`

List Contacts · Read-only

List contacts, filtered by name, email, phone, domain, account, tag, role, address, type or creation and change dates. Returns contact ID, name, email, phone, account, position and tags. Use this to find contacts. Use salesflare_contact_get for one contact. Use salesflare_my_contacts_list for only your own contacts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account` (`integer`, optional): Filter by the Salesflare account ID the record is linked to. Example: 45678.
- `address_city` (`array`, optional): Filter by address city. Example: Ghent.
- `address_country` (`array`, optional): Filter by address country. Example: Belgium.
- `address_state_region` (`array`, optional): Filter by address state or region. Example: East Flanders.
- `creation_after` (`string`, optional): Only records created after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `creation_before` (`string`, optional): Only records created before this ISO 8601 date-time. Example: 2026-06-30T23:59:59Z.
- `domain` (`string`, optional): Filter by website domain, without protocol. Example: acme.com.
- `email` (`string`, optional): Filter by email address. Example: jane@acme.com.
- `id` (`integer`, optional): Return only the record with this Salesflare ID. Example: 12345.
- `include_archived` (`boolean`, optional): Set to true to include archived contacts. Example: false.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 20. Example: 25.
- `modification_after` (`string`, optional): Only records changed after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `modification_before` (`string`, optional): Only records changed before this ISO 8601 date-time. Example: 2026-06-30T23:59:59Z.
- `name` (`string`, optional): Filter by name (exact or partial match). Example: Acme.
- `offset` (`integer`, optional): Number of records to skip, for paging. Defaults to 0. Example: 0.
- `order_by` (`array`, optional): Sort field; add ' desc' for descending order, e.g. 'creation_date desc'. Example: creation_date desc.
- `phone_number` (`string`, optional): Filter by phone number. Example: +32 9 123 45 67.
- `position_role` (`array`, optional): Filter by the contact's job role. Example: CTO.
- `search` (`string`, optional): Free-text search across names, email addresses and domains. Example: acme.
- `tag` (`integer`, optional): Filter by tag ID. Example: 321.
- `tag_name` (`array`, optional): Filter by tag name. Example: enterprise.
- `type` (`string`, optional): customer for contacts linked to an account, mycontacts for your own contacts. One of: customer, mycontacts. Example: customer. One of: `customer`, `mycontacts`.

Example input: `{}`

### `salesflare_currencies_list`

List Currencies · Read-only

List the currencies Salesflare supports. Returns currency ID, ISO code and symbol. Use this to find a currency ID for opportunities.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `salesflare_custom_field_get`

Get Custom Field · Read-only

Get one custom field by ID. Returns its name, API field name, type, options and settings. Use this when you know the field ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the custom field. Example: 2201.
- `item_class` (`string`, required): Record type the custom field belongs to: accounts, contacts or opportunities. Example: accounts. One of: `accounts`, `contacts`, `opportunities`.

Example input: `{"id":2201,"item_class":"accounts"}`

### `salesflare_custom_field_options_list`

List Custom Field Options · Read-only

List the options of a select-type custom field, optionally filtered by text. Returns option ID and name. Use this to find valid values for a select field.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `custom_field_api_field` (`string`, required): API field name of the custom field, from salesflare_custom_fields_list. Example: industry.
- `item_class` (`string`, required): Record type the custom field belongs to: accounts, contacts or opportunities. Example: accounts. One of: `accounts`, `contacts`, `opportunities`.
- `search_string` (`string`, optional): Text to search option names for. Example: Enterprise.

Example input: `{"custom_field_api_field":"<custom_field_api_field>","item_class":"accounts"}`

### `salesflare_custom_field_types_list`

List Custom Field Types · Read-only

List the custom field types (text, number, date, select and so on). Returns type ID and name. Use this to pick the type ID for salesflare_custom_field_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `salesflare_custom_fields_list`

List Custom Fields · Read-only

List the custom fields of accounts, contacts or opportunities, optionally including disabled ones or limited to a pipeline. Returns field ID, name, API field name, type, options and settings. Use this to learn the keys for the custom input on create and update tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_class` (`string`, required): Record type the custom field belongs to: accounts, contacts or opportunities. Example: accounts. One of: `accounts`, `contacts`, `opportunities`.
- `include_disabled` (`boolean`, optional): Set to true to include disabled custom fields. Example: false.
- `name` (`string`, optional): Filter by custom field name. Example: Acme.
- `pipeline` (`integer`, optional): Only fields for this pipeline ID (opportunities). Example: 12.

Example input: `{"item_class":"accounts"}`

### `salesflare_filter_fields_list`

List Filter Fields · Read-only

List the fields you can filter on for an entity (account, person, opportunity, task, workflow...). Returns field ID, label, type, operators and options. Use this to learn which properties exist on a record type.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `entity` (`string`, required): Entity to list filter fields for: account, person, opportunity, campaign, tag, task, workflow, workflow_record, workflow_step_record or lead. Example: account. One of: `account`, `person`, `opportunity`, `campaign`, `tag`, `task`, `workflow`, `workflow_record`, `workflow_step_record`, `lead`.
- `include_pipeline_specific_predefined_filter_fields` (`boolean`, optional): Set to false to leave out pipeline-specific predefined filter fields. Defaults to true. Example: true.
- `pipeline` (`integer`, optional): Pipeline ID, for opportunity fields specific to one pipeline. Example: 12.

Example input: `{"entity":"account"}`

### `salesflare_group_get`

Get Group · Read-only

Get one user group by ID. Returns its name and members. Use this when you know the group ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the group. Example: 5.

Example input: `{"id":5}`

### `salesflare_groups_list`

List Groups · Read-only

List the user groups of the team. Returns group ID, name and members. Use this to find group IDs for opportunity filters.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `salesflare_me_get`

Get Current User · Read-only

Get the user the API key belongs to. Returns user ID, name, email, team, plan and settings. Use this to check the connection or find your own user ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `salesflare_meeting_get`

Get Meeting · Read-only

Get one meeting by ID. Returns date, end date, subject, description, notes, type and participants. Use this when you know the meeting ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `meeting_id` (`integer`, required): Salesflare ID of the meeting. Example: 99887.

Example input: `{"meeting_id":99887}`

### `salesflare_my_contacts_list`

List My Contacts · Read-only

List the contacts of the API key's own user, with the same filters as salesflare_contacts_list. Returns contact ID, name, email, phone, account, position and tags. Use this for your personal contacts. Use salesflare_contacts_list for the whole team.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account` (`integer`, optional): Filter by the Salesflare account ID the record is linked to. Example: 45678.
- `address_city` (`array`, optional): Filter by address city. Example: Ghent.
- `address_country` (`array`, optional): Filter by address country. Example: Belgium.
- `address_state_region` (`array`, optional): Filter by address state or region. Example: East Flanders.
- `creation_after` (`string`, optional): Only records created after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `creation_before` (`string`, optional): Only records created before this ISO 8601 date-time. Example: 2026-06-30T23:59:59Z.
- `domain` (`string`, optional): Filter by website domain, without protocol. Example: acme.com.
- `email` (`string`, optional): Filter by email address. Example: jane@acme.com.
- `id` (`integer`, optional): Return only the record with this Salesflare ID. Example: 12345.
- `include_archived` (`boolean`, optional): Set to true to include archived contacts. Example: false.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 20. Example: 25.
- `modification_after` (`string`, optional): Only records changed after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `modification_before` (`string`, optional): Only records changed before this ISO 8601 date-time. Example: 2026-06-30T23:59:59Z.
- `name` (`string`, optional): Filter by name (exact or partial match). Example: Acme.
- `offset` (`integer`, optional): Number of records to skip, for paging. Defaults to 0. Example: 0.
- `order_by` (`array`, optional): Sort field; add ' desc' for descending order, e.g. 'creation_date desc'. Example: creation_date desc.
- `phone_number` (`string`, optional): Filter by phone number. Example: +32 9 123 45 67.
- `position_role` (`array`, optional): Filter by the contact's job role. Example: CTO.
- `search` (`string`, optional): Free-text search across names, email addresses and domains. Example: acme.
- `tag` (`integer`, optional): Filter by tag ID. Example: 321.
- `tag_name` (`array`, optional): Filter by tag name. Example: enterprise.
- `type` (`string`, optional): customer for contacts linked to an account, mycontacts for your own contacts. One of: customer, mycontacts. Example: customer. One of: `customer`, `mycontacts`.

Example input: `{}`

### `salesflare_opportunities_list`

List Opportunities · Read-only

List opportunities (deals), filtered by name, search text, account, stage, pipeline, owner, assignee, value, close date, creation date, closed or done status, tag or hotness. Returns opportunity ID, name, account, stage, value, currency, probability, close date and owner. Use this to review the pipeline. Use salesflare_opportunity_get for one deal.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account` (`integer`, optional): Filter by the Salesflare account ID the record is linked to. Example: 45678.
- `assignee` (`integer`, optional): Filter by assignee user ID. Example: 1001.
- `close_after` (`string`, optional): Only opportunities with a close date after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `close_before` (`string`, optional): Only opportunities with a close date before this ISO 8601 date-time. Example: 2026-12-31T23:59:59Z.
- `closed` (`boolean`, optional): Set to true for closed opportunities only, false for open ones. Example: false.
- `creation_after` (`string`, optional): Only records created after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `creation_before` (`string`, optional): Only records created before this ISO 8601 date-time. Example: 2026-06-30T23:59:59Z.
- `details` (`boolean`, optional): Set to true to include full details (addresses, phone numbers, social profiles and custom fields) for each record. Example: true.
- `done` (`boolean`, optional): Set to true for opportunities marked done, false for the rest. Example: false.
- `hotness` (`integer`, optional): Hotness level: 1 (room temperature), 2 (hot) or 3 (on fire). One of: 1, 2, 3. Example: 2.
- `id` (`integer`, optional): Return only the record with this Salesflare ID. Example: 12345.
- `limit` (`integer`, optional): Maximum number of records to return. Example: 25.
- `max_value` (`number`, optional): Only opportunities worth at most this value. Example: 50000.
- `min_value` (`number`, optional): Only opportunities worth at least this value. Example: 1000.
- `name` (`string`, optional): Filter by name (exact or partial match). Example: Acme.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `order_by` (`array`, optional): Sort field; add ' desc' for descending order, e.g. 'creation_date desc'. Example: creation_date desc.
- `owner` (`integer`, optional): Filter by owner user ID. Example: 1001.
- `pipeline` (`integer`, optional): Filter by pipeline ID. Example: 12.
- `search` (`string`, optional): Free-text search across names, email addresses and domains. Example: acme.
- `stage` (`integer`, optional): Filter by stage ID. Example: 77.
- `stage_name` (`string`, optional): Filter by stage name. Example: Proposal.
- `status` (`string`, optional): Filter by opportunity status. Example: open.
- `tag` (`integer`, optional): Filter by tag ID. Example: 321.
- `tag_name` (`string`, optional): Filter by tag name. Example: enterprise.
- `team_member` (`integer`, optional): Filter by team member user ID. Example: 1001.

Example input: `{}`

### `salesflare_opportunity_get`

Get Opportunity · Read-only

Get one opportunity by ID. Returns its name, account, stage and pipeline, value, currency, probability, dates, owner, assignee, main contact, tags and custom fields. Use this when you know the opportunity ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Salesflare ID of the opportunity. Example: 88001.

Example input: `{"id":88001}`

### `salesflare_persons_list`

List Persons · Read-only

Look up persons (contacts and users together) by ID, name, email or search text. Returns person ID, name, email and picture. Use this to resolve a name or email to an ID for meeting or call participants.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, optional): Filter by email address. Example: jane@acme.com.
- `id` (`integer`, optional): Return only the record with this Salesflare ID. Example: 12345.
- `name` (`string`, optional): Filter by name (exact or partial match). Example: Acme.
- `search` (`string`, optional): Free-text search across names, email addresses and domains. Example: acme.

Example input: `{}`

### `salesflare_pipelines_list`

List Pipelines · Read-only

List sales pipelines, optionally filtered by search text. Returns pipeline ID, name, order and its stages. Use this to find a pipeline. Use salesflare_stages_list for stage IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_by` (`array`, optional): Sort field; add ' desc' for descending order, e.g. 'creation_date desc'. Example: creation_date desc.
- `search` (`string`, optional): Free-text search across names, email addresses and domains. Example: acme.

Example input: `{}`

### `salesflare_stage_get`

Get Stage · Read-only

Get one pipeline stage by ID. Returns name, order, probability and pipeline. Use this when you know the stage ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `stage_id` (`integer`, required): Salesflare ID of the stage. Example: 77.

Example input: `{"stage_id":77}`

### `salesflare_stages_list`

List Stages · Read-only

List pipeline stages, optionally filtered by ID, name or pipeline. Returns stage ID, name, order, probability and pipeline. Use this to pick the stage for an opportunity.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, optional): Return only the record with this Salesflare ID. Example: 12345.
- `name` (`string`, optional): Filter by name (exact or partial match). Example: Acme.
- `order_by` (`string`, optional): Sort field; add ' desc' for descending order, e.g. 'creation_date desc'. Example: creation_date desc.
- `pipeline_id` (`integer`, optional): Filter by pipeline ID. Example: 12.
- `pipeline_name` (`string`, optional): Filter by pipeline name. Example: Sales.

Example input: `{}`

### `salesflare_tag_get`

Get Tag · Read-only

Get one tag by ID. Returns its ID and name. Use this when you know the tag ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `tag_id` (`integer`, required): Salesflare ID of the tag. Example: 321.

Example input: `{"tag_id":321}`

### `salesflare_tag_usage_get`

Get Tag Usage · Read-only

Get where a tag is used in workflows, saved filters and reports. Returns the lists of those items. Use this before renaming or deleting a tag.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `tag_id` (`integer`, required): Salesflare ID of the tag. Example: 321.

Example input: `{"tag_id":321}`

### `salesflare_tags_list`

List Tags · Read-only

List tags, optionally filtered by ID or name. Returns tag ID, name and usage counts. Use this to find a tag ID. Use salesflare_tag_usage_get to see where a tag is used.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, optional): Return only the record with this Salesflare ID. Example: 12345.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 20. Example: 25.
- `name` (`string`, optional): Filter by name (exact or partial match). Example: Acme.
- `offset` (`integer`, optional): Number of records to skip, for paging. Defaults to 0. Example: 0.
- `order_by` (`array`, optional): Sort field; add ' desc' for descending order, e.g. 'creation_date desc'. Example: creation_date desc.

Example input: `{}`

### `salesflare_tasks_list`

List Tasks · Read-only

List open tasks, filtered by ID, search text, assignee, account or type. Returns task ID, description, due date, assignees, account and type. Use this to see to-dos. Use salesflare_task_update to complete one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account` (`integer`, optional): Filter by the Salesflare account ID the record is linked to. Example: 45678.
- `assignees` (`integer`, optional): Filter by assignee user ID. Example: 1001.
- `id` (`integer`, optional): Return only the record with this Salesflare ID. Example: 12345.
- `limit` (`integer`, optional): Maximum number of records to return. Example: 25.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `order_by` (`array`, optional): Sort field; add ' desc' for descending order, e.g. 'creation_date desc'. Example: creation_date desc.
- `search` (`string`, optional): Free-text search across names, email addresses and domains. Example: acme.

Example input: `{}`

### `salesflare_user_get`

Get User · Read-only

Get one user (team member) by ID. Returns name, email, picture, team and enabled status. Use this when you know the user ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the Salesflare user. Example: 1001.

Example input: `{"id":1001}`

### `salesflare_users_list`

List Users · Read-only

List the users (team members) of the Salesflare team, optionally filtered by ID, name, email or search text. Returns user ID, name, email, picture and enabled status. Use this to find user IDs for owners and assignees.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, optional): Filter by email address. Example: jane@acme.com.
- `id` (`integer`, optional): Return only the record with this Salesflare ID. Example: 12345.
- `limit` (`integer`, optional): Maximum number of records to return. Example: 25.
- `name` (`string`, optional): Filter by name (exact or partial match). Example: Acme.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `only_enabled` (`boolean`, optional): Set to true to list only enabled users. Example: true.
- `order_by` (`array`, optional): Sort field; add ' desc' for descending order, e.g. 'creation_date desc'. Example: creation_date desc.
- `search` (`string`, optional): Free-text search across names, email addresses and domains. Example: acme.

Example input: `{}`

### `salesflare_workflow_get`

Get Workflow · Read-only

Get one workflow by ID. Returns its name, status, goal, filter, schedule, steps and statistics. Use this when you know the workflow ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the workflow. Example: 3001.

Example input: `{"id":3001}`

### `salesflare_workflows_list`

List Workflows · Read-only

List workflows (automated email sequences and campaigns), optionally filtered by search text. Returns workflow ID, name, status, type, steps and audience counts. Use this to review automations. Use salesflare_workflow_get for one workflow.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 20. Example: 25.
- `offset` (`integer`, optional): Number of records to skip, for paging. Defaults to 0. Example: 0.
- `order_by` (`array`, optional): Sort field; add ' desc' for descending order, e.g. 'creation_date desc'. Example: creation_date desc.
- `search` (`string`, optional): Free-text search across names, email addresses and domains. Example: acme.

Example input: `{}`

### `salesflare_account_contacts_update`

Update Account Contacts · Write

Link a contact to an account, or unlink it with remove set to true. Returns a success flag. Use this to manage who belongs to an account. Use salesflare_account_users_update for team members.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `account_id` (`integer`, required): Salesflare ID of the account. Example: 45678.
- `contact_id` (`integer`, required): Salesflare ID of the contact to link or unlink. Example: 56789.
- `remove` (`boolean`, optional): Set to true to unlink the contact instead of linking it. Example: false.

Example input: `{"account_id":45678,"contact_id":56789}`

### `salesflare_account_create`

Create Account · Write

Create an account (company); Salesflare enriches it from the domain. Returns the new account ID. Use salesflare_account_update to change it later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Account (company) name. Example: Acme Inc.
- `address` (`object`, optional): Primary address, as an object with street, city, zip, state_region and country. Example: {"street":"Kortrijksesteenweg 1","city":"Ghent","zip":"9000","country":"Belgium"}
- `custom` (`object`, optional): Custom field values keyed by the custom field API name (see salesflare_custom_fields_list). Example: {"industry":"Software"}
- `description` (`string`, optional): Free-text description of the account. Example: B2B software company in Ghent.
- `domain` (`string`, optional): Company website domain, without protocol. Salesflare uses it to enrich the account. Example: acme.com.
- `email` (`string`, optional): Main email address of the account. Example: info@acme.com.
- `owner` (`integer`, optional): User ID of the account owner (see salesflare_users_list). Example: 1001.
- `parent_account` (`integer`, optional): Salesflare ID of the parent account. Example: 45600.
- `phone_number` (`string`, optional): Main phone number of the account. Example: +32 9 123 45 67.
- `picture` (`string`, optional): Logo image URL. Example: https://www.acme.com/logo.png.
- `size` (`integer`, optional): Employee count. Example: 120.
- `tags` (`array`, optional): Tag names to attach to the account; new names create tags. Example: ["enterprise","partner"]
- `update_if_exists` (`boolean`, optional): Set to true to update the existing account with the same domain instead of creating a duplicate. Example: true.
- `website` (`string`, optional): Company website URL. Example: https://www.acme.com.

Example input: `{"name":"<name>"}`

### `salesflare_account_update`

Update Account · Write

Update the fields you pass on one account; other fields are unchanged. Returns a success flag. Use this to edit an account. Use salesflare_account_contacts_update to link or unlink contacts.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account_id` (`integer`, required): Salesflare ID of the account. Example: 45678.
- `address` (`object`, optional): Primary address, as an object with street, city, zip, state_region and country. Example: {"street":"Kortrijksesteenweg 1","city":"Ghent","zip":"9000","country":"Belgium"}
- `custom` (`object`, optional): Custom field values keyed by the custom field API name (see salesflare_custom_fields_list). Example: {"industry":"Software"}
- `description` (`string`, optional): Free-text description of the account. Example: B2B software company in Ghent.
- `domain` (`string`, optional): Company website domain, without protocol. Salesflare uses it to enrich the account. Example: acme.com.
- `email` (`string`, optional): Main email address of the account. Example: info@acme.com.
- `name` (`string`, optional): Account (company) name. Example: Acme Inc.
- `parent_account` (`integer`, optional): Salesflare ID of the parent account. Example: 45600.
- `phone_number` (`string`, optional): Main phone number of the account. Example: +32 9 123 45 67.
- `picture` (`string`, optional): Logo image URL. Example: https://www.acme.com/logo.png.
- `size` (`integer`, optional): Employee count. Example: 120.
- `tags` (`array`, optional): Tag names to attach to the account; new names create tags. Example: ["enterprise","partner"]
- `website` (`string`, optional): Company website URL. Example: https://www.acme.com.

Example input: `{"account_id":45678}`

### `salesflare_account_users_update`

Update Account Users · Write

Add a team member (user) to an account, or remove one with remove set to true. Returns a success flag. Use this to share an account with a colleague. Use salesflare_account_contacts_update for contacts.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `account_id` (`integer`, required): Salesflare ID of the account. Example: 45678.
- `user_id` (`integer`, required): ID of the Salesflare user to add or remove (see salesflare_users_list). Example: 1001.
- `remove` (`boolean`, optional): Set to true to remove the user instead of adding them. Example: false.

Example input: `{"account_id":45678,"user_id":1001}`

### `salesflare_call_create`

Create Call · Write

Log a phone call with one or more contacts, for example from a phone system's call log. Returns the new call ID. Use salesflare_meeting_create for an in-person meeting.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): Start date and time as an ISO 8601 date-time. Example: 2026-07-10T10:00:00Z.
- `participants` (`array`, required): Contact IDs of the people on the call. Example: [56789]
- `description` (`string`, optional): Call description. Example: Inbound demo request.
- `end_date` (`string`, optional): End date and time as an ISO 8601 date-time. Example: 2026-07-10T10:20:00Z.
- `notes` (`string`, optional): Call notes. Example: Interested in the Pro plan.
- `subject` (`string`, optional): Call subject. Example: Discovery call.

Example input: `{"date":"<date>","participants":[56789]}`

### `salesflare_contact_create`

Create Contact · Write

Create a contact, optionally linked to an account. Returns the new contact ID. Use salesflare_contact_update to change it, and salesflare_account_contacts_update to link it to another account.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `account` (`integer`, optional): Salesflare ID of the account to link the contact to. Example: 45678.
- `address` (`object`, optional): Primary address, as an object with street, city, zip, state_region and country. Example: {"street":"Kortrijksesteenweg 1","city":"Ghent","zip":"9000","country":"Belgium"}
- `birth_date` (`string`, optional): Birth date as an ISO 8601 date-time. Example: 1985-04-12T00:00:00Z.
- `custom` (`object`, optional): Custom field values keyed by the custom field API name. Example: {"lead_source":"Webinar"}
- `email` (`string`, optional): Contact email address. Example: jane@acme.com.
- `firstname` (`string`, optional): First name. Example: Jane.
- `force` (`boolean`, optional): Set to true to create the contact even if one with this email already exists. Example: false.
- `lastname` (`string`, optional): Last name. Example: Doe.
- `mobile_phone_number` (`string`, optional): Mobile phone number. Example: +32 470 12 34 56.
- `name` (`string`, optional): Full name, used when first and last name are not given. Example: Jane Doe.
- `opt_out` (`boolean`, optional): Set to true if the contact opted out of email campaigns. Example: false.
- `owner` (`integer`, optional): User ID of the contact owner. Example: 1001.
- `phone_number` (`string`, optional): Primary phone number. Example: +32 9 123 45 67.
- `position` (`object`, optional): Primary position, as an object with organisation and role. Example: {"organisation":"Acme Inc","role":"CTO"}
- `prefix` (`string`, optional): Name prefix. Example: Dr.
- `tags` (`array`, optional): Tag names to attach to the contact. Example: ["decision-maker"]

Example input: `{}`

### `salesflare_contact_update`

Update Contact · Write

Update the fields you pass on one contact; other fields are unchanged. Set archived to true to archive it. Returns a success flag. Use this to edit a contact.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`integer`, required): Salesflare ID of the contact. Example: 56789.
- `account` (`integer`, optional): Salesflare ID of the account to link the contact to. Example: 45678.
- `address` (`object`, optional): Primary address, as an object with street, city, zip, state_region and country. Example: {"street":"Kortrijksesteenweg 1","city":"Ghent","zip":"9000","country":"Belgium"}
- `archived` (`boolean`, optional): Set to true to archive the contact, false to restore it. Example: false.
- `birth_date` (`string`, optional): Birth date as an ISO 8601 date-time. Example: 1985-04-12T00:00:00Z.
- `custom` (`object`, optional): Custom field values keyed by the custom field API name. Example: {"lead_source":"Webinar"}
- `email` (`string`, optional): Contact email address. Example: jane@acme.com.
- `firstname` (`string`, optional): First name. Example: Jane.
- `force` (`boolean`, optional): Set to true to apply the change even if the email address belongs to another contact. Example: false.
- `lastname` (`string`, optional): Last name. Example: Doe.
- `mobile_phone_number` (`string`, optional): Mobile phone number. Example: +32 470 12 34 56.
- `name` (`string`, optional): Full name, used when first and last name are not given. Example: Jane Doe.
- `opt_out` (`boolean`, optional): Set to true if the contact opted out of email campaigns. Example: false.
- `owner` (`integer`, optional): User ID of the contact owner. Example: 1001.
- `phone_number` (`string`, optional): Primary phone number. Example: +32 9 123 45 67.
- `position` (`object`, optional): Primary position, as an object with organisation and role. Example: {"organisation":"Acme Inc","role":"CTO"}
- `prefix` (`string`, optional): Name prefix. Example: Dr.
- `tags` (`array`, optional): Tag names to attach to the contact. Example: ["decision-maker"]

Example input: `{"contact_id":56789}`

### `salesflare_custom_field_create`

Create Custom Field · Write

Create a custom field on accounts, contacts or opportunities. Returns the new field ID. Use salesflare_custom_field_types_list first to pick the type.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `item_class` (`string`, required): Record type the custom field belongs to: accounts, contacts or opportunities. Example: accounts. One of: `accounts`, `contacts`, `opportunities`.
- `enabled` (`boolean`, optional): Set to false to disable the field. Example: true.
- `name` (`string`, optional): Display name of the custom field. Example: Industry.
- `options` (`array`, optional): Options of a select field, each an object with a name. Example: [{"name":"Software"},{"name":"Retail"}]
- `pipeline` (`integer`, optional): Pipeline ID, to limit an opportunity field to one pipeline. Example: 12.
- `required` (`boolean`, optional): Set to true to make the field required. Example: false.
- `type` (`integer`, optional): Custom field type ID from salesflare_custom_field_types_list. Example: 7.
- `users_can_add_options` (`boolean`, optional): Set to true to let users add options to a select field. Example: false.

Example input: `{"item_class":"accounts"}`

### `salesflare_custom_field_update`

Update Custom Field · Write

Update the fields you pass on one custom field, such as its name, options or enabled status. Returns a success flag. Use this to rename a field or add options.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the custom field. Example: 2201.
- `item_class` (`string`, required): Record type the custom field belongs to: accounts, contacts or opportunities. Example: accounts. One of: `accounts`, `contacts`, `opportunities`.
- `archived` (`boolean`, optional): Set to true to archive the field. Example: false.
- `enabled` (`boolean`, optional): Set to false to disable the field. Example: true.
- `name` (`string`, optional): Display name of the custom field. Example: Industry.
- `options` (`array`, optional): Options of a select field, each an object with a name. Example: [{"name":"Software"},{"name":"Retail"}]
- `pipeline` (`integer`, optional): Pipeline ID, to limit an opportunity field to one pipeline. Example: 12.
- `required` (`boolean`, optional): Set to true to make the field required. Example: false.
- `users_can_add_options` (`boolean`, optional): Set to true to let users add options to a select field. Example: false.

Example input: `{"id":2201,"item_class":"accounts"}`

### `salesflare_meeting_create`

Create Meeting · Write

Log a meeting (in person or by phone) with one or more contacts. Returns the new meeting ID. Use salesflare_call_create to log a phone call from a call log.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): Start date and time as an ISO 8601 date-time. Example: 2026-07-10T14:00:00Z.
- `participants` (`array`, required): Contact IDs of the participants (see salesflare_persons_list). Example: [56789]
- `description` (`string`, optional): Meeting description or agenda. Example: Review usage and renewal.
- `end_date` (`string`, optional): End date and time as an ISO 8601 date-time. Example: 2026-07-10T15:00:00Z.
- `notes` (`string`, optional): Meeting notes. Example: Agreed to send a renewal quote.
- `subject` (`string`, optional): Meeting subject. Example: Quarterly business review.
- `type` (`string`, optional): meeting-live for in person, meeting-phone for a phone meeting. Example: meeting-live. One of: `meeting-live`, `meeting-phone`.

Example input: `{"date":"<date>","participants":[56789]}`

### `salesflare_meeting_update`

Update Meeting Notes · Write

Update the notes of a meeting that comes from a synced calendar; notes are the only field you can change. Returns a success flag. Use this to add notes after a calendar meeting.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `calendar_id` (`string`, required): Calendar ID of the synced meeting, from salesflare_meeting_get. Example: jane@acme.com.
- `external_id` (`string`, required): External (calendar) event ID of the meeting, from salesflare_meeting_get. Example: 7f3k2l9s0dq1.
- `meeting_id` (`integer`, required): Salesflare ID of the meeting. Example: 99887.
- `notes` (`string`, required): New meeting notes. Example: Customer asked for an SSO demo.

Example input: `{"calendar_id":"<calendar_id>","external_id":"<external_id>","meeting_id":99887,"notes":"<notes>"}`

### `salesflare_note_create`

Create Internal Note · Write

Post an internal note on an account's timeline, visible to the team only, optionally mentioning users. Returns the new note ID. Use salesflare_note_update to edit it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `account` (`integer`, required): Salesflare ID of the account to post the note on. Example: 45678.
- `body` (`string`, required): Note text. Example: Spoke with Jane; renewal likely in Q3.
- `date` (`string`, optional): Date of the note as an ISO 8601 date-time; defaults to now. Example: 2026-07-10T16:00:00Z.
- `mentions` (`array`, optional): User IDs to mention and notify. Example: [1001]

Example input: `{"account":45678,"body":"<body>"}`

### `salesflare_note_update`

Update Internal Note · Write

Edit the text, mentions or date of an internal note. Returns a success flag. Use this to correct a note.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account` (`integer`, required): Salesflare ID of the account the note is on. Example: 45678.
- `body` (`string`, required): New note text. Example: Spoke with Jane; renewal confirmed for Q3.
- `message_id` (`integer`, required): Salesflare ID of the internal note. Example: 776655.
- `date` (`string`, optional): Date of the note as an ISO 8601 date-time. Example: 2026-07-10T16:00:00Z.
- `mentions` (`array`, optional): User IDs to mention. Example: [1001]

Example input: `{"account":45678,"body":"<body>","message_id":776655}`

### `salesflare_opportunity_create`

Create Opportunity · Write

Create an opportunity (deal) on an account. Returns the new opportunity ID. Use salesflare_stages_list to pick a stage first. Use salesflare_opportunity_update to move it through stages.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `account` (`integer`, required): Salesflare ID of the account the opportunity belongs to. Example: 45678.
- `assignee` (`integer`, optional): User ID of the assignee. Example: 1001.
- `close_date` (`string`, optional): Expected or actual close date as an ISO 8601 date-time. Example: 2026-09-30T00:00:00Z.
- `closed` (`boolean`, optional): Set to true to close the opportunity. Example: false.
- `contract_end_date` (`string`, optional): Contract end date as an ISO 8601 date-time. Example: 2027-09-30T00:00:00Z.
- `contract_start_date` (`string`, optional): Contract start date as an ISO 8601 date-time. Example: 2026-10-01T00:00:00Z.
- `currency` (`integer`, optional): Currency ID (see salesflare_currencies_list). Example: 1.
- `custom` (`object`, optional): Custom field values keyed by the custom field API name. Example: {"deal_type":"New"}
- `frequency` (`string`, optional): Recurrence frequency for recurring revenue. Example: monthly. One of: `annually`, `weekly`, `monthly`, `daily`.
- `lead_source` (`integer`, optional): Lead source ID. Example: 2.
- `lost_reason` (`integer`, optional): Lost reason ID, when closing an opportunity as lost. Example: 3.
- `main_contact` (`integer`, optional): Contact ID of the main contact. Example: 56789.
- `name` (`string`, optional): Opportunity name. Example: Acme annual license.
- `owner` (`integer`, optional): User ID of the owner. Example: 1001.
- `probability` (`integer`, optional): Win probability in percent. Example: 60.
- `recurring_price_per_unit` (`number`, optional): Recurring price per unit. Example: 100.
- `stage` (`integer`, optional): Stage ID (see salesflare_stages_list); the stage also sets the pipeline. Example: 77.
- `start_date` (`string`, optional): Start date as an ISO 8601 date-time. Example: 2026-07-01T00:00:00Z.
- `tags` (`array`, optional): Tag names to attach. Example: ["upsell"]
- `units` (`integer`, optional): Number of units. Example: 10.
- `value` (`number`, optional): Monetary value. Example: 12000.

Example input: `{"account":45678}`

### `salesflare_opportunity_update`

Update Opportunity · Write

Update the fields you pass on one opportunity, such as stage, value, close date or closed status; other fields are unchanged. Returns a success flag. Use this to move a deal or close it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Salesflare ID of the opportunity. Example: 88001.
- `account` (`integer`, optional): Salesflare ID of the account the opportunity belongs to. Example: 45678.
- `assignee` (`integer`, optional): User ID of the assignee. Example: 1001.
- `close_date` (`string`, optional): Expected or actual close date as an ISO 8601 date-time. Example: 2026-09-30T00:00:00Z.
- `closed` (`boolean`, optional): Set to true to close the opportunity. Example: false.
- `contract_end_date` (`string`, optional): Contract end date as an ISO 8601 date-time. Example: 2027-09-30T00:00:00Z.
- `contract_start_date` (`string`, optional): Contract start date as an ISO 8601 date-time. Example: 2026-10-01T00:00:00Z.
- `custom` (`object`, optional): Custom field values keyed by the custom field API name. Example: {"deal_type":"New"}
- `done` (`boolean`, optional): Set to true to mark the opportunity done. Example: false.
- `frequency` (`string`, optional): Recurrence frequency for recurring revenue. Example: monthly. One of: `annually`, `weekly`, `monthly`, `daily`.
- `lead_source` (`integer`, optional): Lead source ID. Example: 2.
- `lost_reason` (`integer`, optional): Lost reason ID, when closing an opportunity as lost. Example: 3.
- `main_contact` (`integer`, optional): Contact ID of the main contact. Example: 56789.
- `name` (`string`, optional): Opportunity name. Example: Acme annual license.
- `owner` (`integer`, optional): User ID of the owner. Example: 1001.
- `probability` (`integer`, optional): Win probability in percent. Example: 60.
- `recurring_price_per_unit` (`number`, optional): Recurring price per unit. Example: 100.
- `stage` (`integer`, optional): Stage ID (see salesflare_stages_list); the stage also sets the pipeline. Example: 77.
- `start_date` (`string`, optional): Start date as an ISO 8601 date-time. Example: 2026-07-01T00:00:00Z.
- `tags` (`array`, optional): Tag names to attach. Example: ["upsell"]
- `units` (`integer`, optional): Number of units. Example: 10.
- `value` (`number`, optional): Monetary value. Example: 12000.

Example input: `{"id":88001}`

### `salesflare_tag_create`

Create Tag · Write

Create a tag. Returns the new tag ID. Use salesflare_tag_update to rename it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Tag name. Example: enterprise.

Example input: `{"name":"<name>"}`

### `salesflare_tag_update`

Update Tag · Write

Rename one tag. Returns a success flag. Use this to fix or change a tag name everywhere it is used.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, required): New tag name. Example: enterprise-2026.
- `tag_id` (`integer`, required): Salesflare ID of the tag. Example: 321.

Example input: `{"name":"<name>","tag_id":321}`

### `salesflare_task_create`

Create Task · Write

Create a task, optionally linked to an account and assigned to users. Returns the new task ID. Use salesflare_task_update to change or complete it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, required): What needs to be done. Example: Send the proposal to Acme.
- `account` (`integer`, optional): Salesflare ID of the account the task is about. Example: 45678.
- `assignees` (`array`, optional): User IDs to assign the task to. Example: [1001]
- `reminder_date` (`string`, optional): Due date and time as an ISO 8601 date-time. Example: 2026-07-15T09:00:00Z.

Example input: `{"description":"<description>"}`

### `salesflare_task_update`

Update Task · Write

Update a task's description, due date, account or assignees, or mark it completed. Returns a success flag. Use this to complete or reschedule a task.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Salesflare ID of the task. Example: 66001.
- `account` (`integer`, optional): Salesflare ID of the account the task is about. Example: 45678.
- `assignees` (`array`, optional): User IDs to assign the task to. Example: [1001]
- `completed` (`boolean`, optional): Set to true to mark the task completed. Example: true.
- `description` (`string`, optional): What needs to be done. Example: Send the revised proposal to Acme.
- `reminder_date` (`string`, optional): Due date and time as an ISO 8601 date-time. Example: 2026-07-16T09:00:00Z.

Example input: `{"id":66001}`

### `salesflare_workflow_audience_update`

Exit or Re-enter Workflow · Write

Exit a contact or other record from a workflow (exited true), or let it re-enter (exited false). Returns a success flag. Use this to stop a sequence for one person.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `exited` (`boolean`, required): true exits the record from the workflow; false lets it re-enter. Example: true.
- `id` (`integer`, required): ID of the workflow. Example: 3001.
- `record_id` (`integer`, required): ID of the record (usually a contact) in the workflow audience. Example: 56789.

Example input: `{"exited":true,"id":3001,"record_id":56789}`

### `salesflare_account_delete`

Delete Account · Destructive

Delete one account. Returns a success flag. Use this only to remove an account permanently.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `account_id` (`integer`, required): Salesflare ID of the account. Example: 45678.

Example input: `{"account_id":45678}`

### `salesflare_contact_delete`

Delete Contact · Destructive

Delete one contact. Returns a success flag. Use this to remove a contact permanently. Use salesflare_contact_update with archived true to hide it instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`integer`, required): Salesflare ID of the contact. Example: 56789.

Example input: `{"contact_id":56789}`

### `salesflare_custom_field_delete`

Delete Custom Field · Destructive

Delete one custom field and its values. Returns a success flag. Use salesflare_custom_field_update with enabled false to hide it instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the custom field. Example: 2201.
- `item_class` (`string`, required): Record type the custom field belongs to: accounts, contacts or opportunities. Example: accounts. One of: `accounts`, `contacts`, `opportunities`.

Example input: `{"id":2201,"item_class":"accounts"}`

### `salesflare_meeting_delete`

Delete Meeting · Destructive

Delete one logged meeting. Returns a success flag. Use this to remove a meeting logged by mistake.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `meeting_id` (`integer`, required): Salesflare ID of the meeting. Example: 99887.

Example input: `{"meeting_id":99887}`

### `salesflare_note_delete`

Delete Internal Note · Destructive

Delete one internal note. Returns a success flag. Use this to remove a note.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`integer`, required): Salesflare ID of the internal note. Example: 776655.

Example input: `{"message_id":776655}`

### `salesflare_opportunity_delete`

Delete Opportunity · Destructive

Delete one opportunity. Returns a success flag. Use this to remove a deal permanently. Use salesflare_opportunity_update with closed true to close it instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Salesflare ID of the opportunity. Example: 88001.

Example input: `{"id":88001}`

### `salesflare_tag_delete`

Delete Tag · Destructive

Delete one tag and remove it from all records. Returns a success flag. Use salesflare_tag_usage_get first to check where it is used.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `tag_id` (`integer`, required): Salesflare ID of the tag. Example: 321.

Example input: `{"tag_id":321}`

### `salesflare_task_delete`

Delete Task · Destructive

Delete one task. Returns a success flag. Use this to remove a task. Use salesflare_task_update with completed true to complete it instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Salesflare ID of the task. Example: 66001.

Example input: `{"id":66001}`

## Related

Other CRM & Sales connectors ([all 174](/agentkit/connectors/?category=crm-sales)):

- [Salesforce](/agentkit/connectors/salesforce/): Scalekit connector, OAuth, 74 tools
- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Close](/agentkit/connectors/close/): Scalekit connector, OAuth, 103 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
