> **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 ClickFunnels

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

**Authentication:** Bearer Token
**Categories:** Marketing, CRM & Sales
**Tools:** 56: 37 read, 15 write, 4 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=CLICKFUNNELS)

## 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 ClickFunnels connection

   In **AgentKit > Connections**, create a ClickFunnels 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 = 'clickfunnels'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize ClickFunnels:', 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: 'clickfunnels_me_get',
     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 = "clickfunnels"
   identifier = "user_123"

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

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

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their ClickFunnels 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: 'clickfunnels_broadcast_get',
  toolInput: {
    broadcast_id: '<broadcast_id>',
  },
  connector: 'clickfunnels',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="clickfunnels_broadcast_get",
    tool_input={
        "broadcast_id": "<broadcast_id>",
    },
    connection_name="clickfunnels",
    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.

### `clickfunnels_broadcast_get`

Get Email Broadcast · Read-only

Get one email broadcast with its subject, content, audience and status.
Returns an object with id, public_id, workspace_id, name, subject, preheadline, status, origination_channel_type, origination_channel_id, external_id, and more.
Use clickfunnels_broadcast_get for one broadcast.

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

Inputs:

- `broadcast_id` (`string`, required): Broadcast ID (numeric id or public id). Example: 1234

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

### `clickfunnels_broadcast_stats_get`

Get Email Broadcast Stats · Read-only

Get delivery progress, engagement (opens, clicks) and revenue for an email broadcast.
Returns an object with broadcast, currency, timerange, progress, performance, revenue, variants.
Use clickfunnels_broadcast_stats_get after sending.

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

Inputs:

- `broadcast_id` (`string`, required): Broadcast ID. Example: 1234

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

### `clickfunnels_broadcasts_list`

List Email Broadcasts · Read-only

List the email broadcasts in a workspace.
Returns an array of objects with id, public_id, workspace_id, name, subject, preheadline, status, origination_channel_type.
Use clickfunnels_broadcasts_list to find a broadcast. Use clickfunnels_broadcast_stats_get for results.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `id` (`string`, optional): A comma-separated list of broadcast IDs to filter by. Example: 1,42
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `status` (`string`, optional): A comma-separated list of statuses to filter by (draft, scheduled, sending, paused, unhealthy, complete, canceled). Example: draft,scheduled

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

### `clickfunnels_contact_events_list`

List Contact Activity · Read-only

List the activity events of a contact (page views, opt-ins, purchases, emails, notes).
Returns an array of objects with id, public_id, contact_id, type_key, type_label, occurred_at, actor_id, data.
Use clickfunnels_contact_events_list to see what a contact did.

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

Inputs:

- `contact_id` (`string`, required): Contact ID. Example: 1234
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `type` (`string`, optional): Comma-separated event type keys. Unknown keys match no events. Example: $order.successful_purchase,$contact.note

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

### `clickfunnels_contact_get`

Get Contact · Read-only

Get one contact with name, email, phone, tags and custom attributes.
Returns an object with id, public_id, workspace_id, default_shipping_address_id, anonymous, email_address, first_name, last_name, phone_number, time_zone, and more.
Use clickfunnels_contact_get for a contact you know the ID of.

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

Inputs:

- `contact_id` (`string`, required): Contact ID (numeric id or public id). Example: 1234

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

### `clickfunnels_contact_notes_list`

List Contact Notes · Read-only

List the notes in a contact's activity tab.
Returns an array of objects with id, public_id, contact_id, content, created_by_id, occurred_at, created_at, updated_at.
Use clickfunnels_contact_notes_list for notes. Use clickfunnels_contact_events_list for all activity.

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

Inputs:

- `contact_id` (`string`, required): Contact ID. Example: 1234
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_contact_tags_list`

List Contact Applied Tags · Read-only

List the tags applied to a contact.
Returns an array of objects with id, public_id, contact_id, tag_id, created_at, updated_at, tag, contact.
Use clickfunnels_contact_tags_list for one contact. Use clickfunnels_tags_list for all workspace tags.

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

Inputs:

- `contact_id` (`string`, required): Contact ID. Example: 1234
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `id` (`string`, optional): A comma-separated list of applied tag IDs to filter by. Example: 1,42
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `tag_id` (`string`, optional): A comma-separated list of tag IDs to filter by. Example: 1,2,3

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

### `clickfunnels_contacts_list`

List Contacts · Read-only

List identified contacts in a workspace, optionally filtered by email address or other fields.
Returns an array of objects with id, public_id, workspace_id, default_shipping_address_id, anonymous, email_address, first_name, last_name.
Use clickfunnels_contacts_list to find contacts. Use clickfunnels_contact_get for one contact.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `email_address` (`string`, optional): Comma-separated email addresses to match. Example: jane@example.com
- `id` (`string`, optional): A comma-separated list of contact IDs to filter by. Example: 1,42
- `is_active` (`boolean`, optional): Filter contacts by their active status. Pass true to return only active contacts, or false to return only inactive contacts. Example: True
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `tag_ids` (`string`, optional): A comma-separated list of Contacts::Tag IDs to filter contacts that had those tags applied to them. Example: 1,42

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

### `clickfunnels_course_enrollments_list`

List Course Enrollments · Read-only

List the enrollments (students) of a course.
Returns an array of objects with id, public_id, contact_id, course_id, created_at, updated_at, suspended, suspension_reason.
Use clickfunnels_course_enrollments_list to see who has access to a course.

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

Inputs:

- `course_id` (`string`, required): Course ID. Example: 1234
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `contact_id` (`string`, optional): A comma-separated list of contact IDs to filter by. Example: 1,42
- `id` (`string`, optional): A comma-separated list of enrollment IDs to filter by. Example: 1,2,3
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_course_get`

Get Course · Read-only

Get one course with its settings and publish state.
Returns an object with id, public_id, title, published_at, root_section_id, description, current_path, sharing_fingerprint, show_in_community, show_to_non_members, and more.
Use clickfunnels_course_get for one course.

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

Inputs:

- `course_id` (`string`, required): Course ID (numeric id or public id). Example: 1234

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

### `clickfunnels_courses_list`

List Courses · Read-only

List the courses in a workspace.
Returns an array of objects with id, public_id, title, published_at, root_section_id, description, current_path, sharing_fingerprint.
Use clickfunnels_courses_list to find a course ID.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_form_submissions_list`

List Form Submissions · Read-only

List the submissions of a form.
Returns an array of objects with id, public_id, form_id, contact_id, created_at, updated_at.
Use clickfunnels_form_submissions_list to read what people entered.

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

Inputs:

- `form_id` (`string`, required): Form ID. Example: 1234
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_forms_list`

List Forms · Read-only

List the forms in a workspace.
Returns an array of objects with id, public_id, workspace_id, name, created_at, updated_at.
Use clickfunnels_forms_list to find a form ID.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_fulfillments_list`

List Fulfillments · Read-only

List order fulfillments (shipments) in a workspace.
Returns an array of objects with id, public_id, workspace_id, contact_id, status, tracking_url, shipping_provider, tracking_code.
Use clickfunnels_fulfillments_list to track shipping of physical products.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_funnel_get`

Get Funnel · Read-only

Get one funnel with its settings, path, domain and tags.
Returns an object with id, public_id, workspace_id, name, archived, current_path, live_mode, domain_id, favicon_image_id, created_at, and more.
Use clickfunnels_funnel_get for one funnel. Use clickfunnels_funnel_stats_get for its numbers.

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

Inputs:

- `funnel_id` (`string`, required): Funnel ID (numeric id or public id). Example: 1234

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

### `clickfunnels_funnel_stats_get`

Get Funnel Stats · Read-only

Get statistics for a funnel: views, opt-ins, sales and earnings per step over a time range.
Returns an object with funnel, currency, timerange, summary, page_public_ids, steps.
Use clickfunnels_funnel_stats_get to measure a funnel.

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

Inputs:

- `funnel_id` (`string`, required): Funnel ID. Example: 1234
- `timerange_end` (`string`, optional): End of the stats timerange (ISO 8601 only; any other value is a 422. Send an offset's + as %2B, since an unencoded + arrives as a space). Defaults to the current time. Values in the future are automatically clamped to now. Example: 2026-01-31T23:59:59Z
- `timerange_start` (`string`, optional): Start of the stats timerange (ISO 8601 only; any other value is a 422. Send an offset's + as %2B, since an unencoded + arrives as a space). Defaults to 30 days before timerange_end. If the window between start and end exceeds 90 days, start is automatically clamped to 90 days before end. If start is after end, the window resets to the default 30 days ending at timerange_end. Example: 2026-01-01T00:00:00Z

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

### `clickfunnels_funnels_list`

List Funnels · Read-only

List the funnels in a workspace.
Returns an array of objects with id, public_id, workspace_id, name, archived, current_path, live_mode, domain_id.
Use clickfunnels_funnels_list to find a funnel ID.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `id` (`string`, optional): A comma-separated list of funnel IDs to filter by. Example: 1,42
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_invoices_list`

List Invoices · Read-only

List invoices across a workspace.
Returns an array of objects with id, public_id, order_id, status, due_amount, total_amount, subtotal_amount, tax_amount.
Use clickfunnels_invoices_list to review billing across orders.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `external_id` (`string`, optional): A comma-separated list of External IDs to filter by. Example: inv_1234567890,inv_0987654321
- `id` (`string`, optional): A comma-separated list of Invoice IDs to filter by. Example: 1,42
- `invoice_number` (`string`, optional): A comma-separated list of Invoice Numbers to filter by. Example: #1000,#1001
- `invoice_type` (`string`, optional): The type of the invoice to filter by. Example: one_time_sale
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `status` (`string`, optional): The status of the invoice to filter by. Example: pending

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

### `clickfunnels_me_get`

Get Current User · Read-only

Get the user the access token belongs to.
Returns an object with id, public_id, email, first_name, last_name, time_zone, locale, created_at, updated_at, connected_workspace, and more.
Use clickfunnels_me_get to check the connection.

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

Inputs: none.

Example input: `{}`

### `clickfunnels_opportunities_list`

List Opportunities · Read-only

List sales opportunities in a workspace.
Returns an array of objects with id, public_id, name, workspace_id, pipeline_id, pipelines_stage_id, primary_contact_id, value.
Use clickfunnels_opportunities_list to review deals. Use clickfunnels_opportunity_get for one.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `assignee_id` (`string`, optional): A comma-separated list of assignee memberships IDs to filter by. Example: 1,42
- `id` (`string`, optional): A comma-separated list of opportunity IDs to filter by. Example: 1,42
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `pipeline_id` (`string`, optional): A comma-separated list of pipeline IDs to filter by. Example: 1,42
- `pipelines_stage_id` (`string`, optional): A comma-separated list of pipelines stage IDs to filter by. Example: 1,42
- `primary_contact_id` (`string`, optional): A comma-separated list of primary contact IDs to filter by. Example: 1,42
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_opportunity_get`

Get Opportunity · Read-only

Get one sales opportunity with its stage, value and contact.
Returns an object with id, public_id, name, workspace_id, pipeline_id, pipelines_stage_id, primary_contact_id, value, sort_order, closed_at, and more.
Use clickfunnels_opportunity_get for one deal.

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

Inputs:

- `opportunity_id` (`string`, required): Opportunity ID (numeric id or public id). Example: 1234

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

### `clickfunnels_order_get`

Get Order · Read-only

Get one order with its line items, totals, status and contact.
Returns an object with id, public_id, order_number, total_amount, origination_channel_id, origination_channel_type, notes, live_mode, in_trial, billing_status, and more.
Use clickfunnels_order_get for one order.

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

Inputs:

- `order_id` (`string`, required): Order ID (numeric id or public id). Example: 1234

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

### `clickfunnels_order_invoices_list`

List Order Invoices · Read-only

List the invoices of an order.
Returns an array of objects with id, public_id, order_id, status, due_amount, total_amount, subtotal_amount, tax_amount.
Use clickfunnels_order_invoices_list for one order. Use clickfunnels_invoices_list for the workspace.

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

Inputs:

- `order_id` (`string`, required): Order ID. Example: 1234
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `external_id` (`string`, optional): A comma-separated list of External IDs to filter by. Example: inv_1234567890,inv_0987654321
- `id` (`string`, optional): A comma-separated list of Invoice IDs to filter by. Example: 1,42
- `invoice_number` (`string`, optional): A comma-separated list of Invoice Numbers to filter by. Example: #1000,#1001
- `invoice_type` (`string`, optional): The type of the invoice to filter by. Example: one_time_sale
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `status` (`string`, optional): The status of the invoice to filter by. Example: pending

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

### `clickfunnels_order_transactions_list`

List Order Transactions · Read-only

List the payment transactions (charges and refunds) of an order.
Returns an array of objects with id, public_id, order_id, status, external_type, external_id, amount, currency.
Use clickfunnels_order_transactions_list to check payments on an order.

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

Inputs:

- `order_id` (`string`, required): Order ID. Example: 1234
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_orders_list`

List Orders · Read-only

List orders in a workspace, optionally filtered by contact, product or status.
Returns an array of objects with id, public_id, order_number, total_amount, origination_channel_id, origination_channel_type, notes, live_mode.
Use clickfunnels_orders_list to find orders. Use clickfunnels_order_get for one order.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `contact_id` (`string`, optional): A comma-separated list of Contact IDs to filter by. Example: 1,42
- `id` (`string`, optional): A comma-separated list of Order IDs to filter by. Example: 1,42
- `live_mode` (`boolean`, optional): Filter by live vs test orders: true for live/production orders, false for test orders. Example: False
- `order_type` (`string`, optional): The order type to filter by. One of: subscription-order, one-time-order. Example: subscription-order. One of: `subscription-order`, `one-time-order`.
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_pipeline_stages_list`

List Pipeline Stages · Read-only

List the stages of a sales pipeline.
Returns an array of objects with id, public_id, workspace_id, pipeline_id, name, sort_order, close_probability, opportunity_ids.
Use clickfunnels_pipeline_stages_list to find a stage ID for an opportunity.

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

Inputs:

- `pipeline_id` (`string`, required): Pipeline ID. Example: 1234
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `id` (`string`, optional): A comma-separated list of stage IDs to filter by (within the scope of the pipeline). Example: 1,42
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_pipelines_list`

List Sales Pipelines · Read-only

List the sales pipelines in a workspace.
Returns an array of objects with id, public_id, workspace_id, name, created_at, updated_at, total_value, stages.
Use clickfunnels_pipelines_list to find a pipeline ID.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `id` (`string`, optional): A comma-separated list of pipeline IDs to filter by. Example: 1,42
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_product_get`

Get Product · Read-only

Get one product with its variants, prices and settings.
Returns an object with id, public_id, workspace_id, name, current_path, archived, visible_in_store, visible_in_customer_center, image_id, seo_title, and more.
Use clickfunnels_product_get for one product.

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

Inputs:

- `product_id` (`string`, required): Product ID (numeric id or public id). Example: 1234

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

### `clickfunnels_product_prices_list`

List Product Prices · Read-only

List every price of a product across its variants.
Returns an array of objects with id, public_id, variant_id, name, amount, cost, currency, duration.
Use clickfunnels_product_prices_list to read pricing.

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

Inputs:

- `product_id` (`string`, required): Product ID. Example: 1234
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `archived` (`boolean`, optional): Filter prices by archived state. Example: True
- `id` (`string`, optional): A comma-separated list of price IDs to filter by. Example: 1,2,3
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `variant_id` (`string`, optional): A comma-separated list of variant IDs to filter by. Example: 1,2,3
- `visible` (`boolean`, optional): Filter prices by visibility in the online store. Example: True

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

### `clickfunnels_product_variants_list`

List Product Variants · Read-only

List the variants of a product.
Returns an array of objects with id, public_id, product_id, name, description, sku, product_type, properties_value_ids.
Use clickfunnels_product_variants_list to find a variant ID.

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

Inputs:

- `product_id` (`string`, required): Product ID. Example: 1234
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `archived` (`boolean`, optional): Filter variants by archived state. Example: True
- `fulfillment_required` (`boolean`, optional): Filter variants by fulfillment required state. Example: True
- `id` (`string`, optional): A comma-separated list of variant IDs to filter by. Example: 1,2,3
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `visible` (`boolean`, optional): Filter variants by visibility in the online store. Example: True

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

### `clickfunnels_products_list`

List Products · Read-only

List the products in a workspace.
Returns an array of objects with id, public_id, workspace_id, name, current_path, archived, visible_in_store, visible_in_customer_center.
Use clickfunnels_products_list to find a product ID. Use clickfunnels_product_get for one product.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `archived` (`boolean`, optional): Filter products by archived state. Example: True
- `id` (`string`, optional): A comma-separated list of product IDs to filter by. Example: 1,2,3
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `visible_in_customer_center` (`boolean`, optional): Filter products by visibility in the customer center. Example: True
- `visible_in_store` (`boolean`, optional): Filter products by visibility in the online store. Example: True

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

### `clickfunnels_scheduled_events_list`

List Scheduled Appointments · Read-only

List booked appointments (scheduled events) in a workspace.
Returns an array of objects with id, public_id, workspace_id, start_on, end_on, status, max_invitees, order_id.
Use clickfunnels_scheduled_events_list to see upcoming bookings.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_tags_list`

List Contact Tags · Read-only

List the contact tags defined in a workspace.
Returns an array of objects with id, public_id, workspace_id, name, color, created_at, updated_at.
Use clickfunnels_tags_list to find a tag ID.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `id` (`string`, optional): A comma-separated list of tag IDs to filter by. Example: 1,42
- `name` (`string`, optional): A comma-separated list of tag names to filter by. Example: cool-user,gold
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_team_workspaces_list`

List Workspaces · Read-only

List the workspaces of a team.
Returns an array of objects with id, public_id, team_id, name, subdomain, created_at, updated_at.
Use clickfunnels_team_workspaces_list to find the workspace_id most tools need.

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

Inputs:

- `team_id` (`string`, required): Team ID from clickfunnels_teams_list. Example: 1200
- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

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

### `clickfunnels_teams_list`

List Teams · Read-only

List the teams the token can access.
Returns an array of objects with id, public_id, name, time_zone, locale, created_at, updated_at, billing_subscriptions.
Use clickfunnels_teams_list to find a team ID for clickfunnels_team_workspaces_list.

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

Inputs:

- `after` (`string`, optional): Cursor: return records after this ID (use the last ID of the previous page). Example: 1234
- `per_page` (`integer`, optional): Records per page, up to 100 (default 20). Example: 50
- `sort_order` (`string`, optional): Sort direction. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

Example input: `{}`

### `clickfunnels_workspace_get`

Get Workspace · Read-only

Get one workspace with its name, subdomain and settings.
Returns an object with id, public_id, team_id, name, subdomain, created_at, updated_at.
Use clickfunnels_workspace_get for one workspace.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id). Example: 42000

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

### `clickfunnels_workspace_stats_get`

Get Workspace Stats · Read-only

Get aggregate statistics for a workspace, such as revenue, orders and contacts, over a filtered set of records.
Returns an object with resource, workspace_id, stats, unavailable, unavailable_reason.
Use clickfunnels_workspace_stats_get for totals. Use clickfunnels_funnel_stats_get for one funnel.

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

Inputs:

- `resource` (`string`, required): The resource to report on. One of: contact, order, form_submission. Example: contact. One of: `contact`, `order`, `form_submission`.
- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `count` (`boolean`, optional): How many records match. Exact unless counting a set of more than 100,000 cannot finish in time - see count_capped_at in the response. Example: false
- `count_by_property` (`string`, optional): Allow-listed per resource - contact: is_active, anonymous, email_suppression_reason, time_zone; order: billing_status, service_status, order_type, live_mode; form_submission: page_id. A 422 lists them. Example: is_active
- `created_at_range` (`boolean`, optional): The earliest and latest created_at in the matching set. Exact; listed in unavailable instead when it cannot finish in time. Example: false
- `filter` (`string`, optional): Simple field matches. The keys the resource's index accepts - contact: id, email_address, is_active, tag_ids; order: id, contact_id, order_type, billing_status, service_status, live_mode; form_submission: id, page_id, contact_id - plus created_at_after (inclusive) and created_at_before (exclusive, both ISO 8601 only; send an offset's + as %2B) on every resource, and funnel_id and product_id on order. Example: example
- `sum_property` (`string`, optional): Allow-listed per resource - order: total_amount, tax_amount, total_collected. A 422 lists them. Example: total_amount

Example input: `{"resource":"contact","workspace_id":"<workspace_id>"}`

### `clickfunnels_broadcast_create`

Create Email Broadcast · Write

Create an email broadcast as a draft.
Returns an object with id, public_id, workspace_id, name, subject, preheadline, status, origination_channel_type, origination_channel_id, external_id, and more.
Use clickfunnels_broadcast_create to draft an email, then clickfunnels_broadcast_send to send it.

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

Inputs:

- `from_email` (`string`, required): Sender email address. Required on create. Must be an email address that belongs to the workspace, and it must have usable_as_sender: true or the send is rejected with 422. Do not pick by the sending domain's verified flag: that covers email transport only. See GET /workspaces/<workspace_id>/emails/addresses, where a shared workspace-default address is usable only while the workspace has no ready custom sender. Example: jane@example.com
- `name` (`string`, required): Internal name for the broadcast (required) Example: Example name
- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `external_id` (`string`, optional): An optional external identifier for your own tracking. Example: abc123
- `filter_id` (`string`, optional): Contact filter for the broadcast audience. Accepts any of three forms: the numeric id or the public id (string) of a saved contact filter (Refine::StoredFilter) in this workspace, or a serialized contact filter. The supplied filter is copied onto the broadcast — the broadcast points at its own copy, so later edits to (or deletion of) the saved filter never change this broadcast's audience. Example: abc123
- `html_body` (`string`, optional): HTML email body. If provided without a template_id, a template is automatically created from this content. Example: example
- `preheadline` (`string`, optional): Preview text shown in email clients before opening. Maximum 150 characters. Example: example
- `recipients` (`array`, optional): List of recipients (maximum 1,000). Contacts are created or matched by email address. Example: [{"key": "value"}]
- `reply_to_email` (`string`, optional): Reply-to email address. Must be an address in the workspace if provided. Pick one whose usable_as_sender is true. Example: jane@example.com
- `send_at` (`string`, optional): Scheduled send date. Required when send_immediately is false. Example: 2026-01-31T12:00:00Z
- `send_at_local_time` (`string`, optional): Scheduled send time in HH:MM:SS format. Defaults to 18:00:00. Example: example
- `send_immediately` (`boolean`, optional): Set to true to send the broadcast immediately upon creation. If false, use send_at, send_at_local_time, and time_zone to schedule. Example: true
- `smart_sending` (`boolean`, optional): Smart Sending. When true the broadcast is delivered gradually across a window rather than all at once, which protects deliverability. Defaults to true: send false explicitly to deliver the whole audience in one go. Above 5,000 recipients Smart Sending is mandatory: sending false is accepted and may be stored as true. The send batches at that size regardless of the stored value. Example: true
- `smart_sending_time` (`number`, optional): How many smart_sending_units the delivery window spans, for example 2 with hour. Must be between 0.5 and 100, and must be sent together with smart_sending_unit. Omit both to size the window from the audience, which is the recommended default. Example: 10
- `smart_sending_unit` (`string`, optional): The unit of the Smart Sending delivery window. Must be sent together with smart_sending_time. Omit both to size the window from the audience, which is the recommended default. One of: hour, day. Example: hour. One of: `hour`, `day`.
- `split_test` (`boolean`, optional): Enable a subject-line split test. Requires exactly one alternate in variants. When enabled without stored settings, percentage defaults to 100 and wait time defaults to 0 hours. Must be a JSON boolean - string spellings such as "true" return 422. Example: true
- `split_test_percentage` (`integer`, optional): Whole-number share of the audience used for the test sends. The share is divided evenly between variant A and variant B. Example: 10
- `split_test_wait_time` (`integer`, optional): Whole hours to wait before choosing the subject-line winner. Example: 10
- `subject` (`string`, optional): Email subject line seen by recipients. Example: Q4 renewal
- `template_id` (`integer`, optional): Numeric id of an existing email template in this workspace to use. Alternative to providing html_body/text_body directly; takes precedence when both are given. The broadcast references this template (it is not copied). Example: 12345
- `text_body` (`string`, optional): Plain text email body. Example: example
- `time_zone` (`string`, optional): Time zone for scheduling (defaults to workspace time zone) Example: America/New_York
- `topic_ids` (`array`, optional): Topic IDs to associate. Only topics belonging to the workspace are accepted. Example: [1, 2]
- `variants` (`array`, optional): Zero or one alternate subject-line variant B. The top-level subject and preheadline are variant A. Supplying B does not enable testing by itself. Example: [{"key": "value"}]

Example input: `{"from_email":"<from_email>","name":"<name>","workspace_id":"<workspace_id>"}`

### `clickfunnels_broadcast_send`

Send Email Broadcast · Write

Send an email broadcast to its audience now or at a scheduled time.
Returns an object with id, public_id, workspace_id, send_type, target_ids, target_count, performed_count, scheduled_for, started_at, completed_at, and more.
Use clickfunnels_broadcast_send to send a finished draft. This emails real contacts.

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

Inputs:

- `broadcast_id` (`string`, required): Broadcast ID. Example: 1234
- `send_at` (`string`, optional): Optional ISO 8601 datetime, which must be in the future. When provided, the broadcast is scheduled to send at that moment (to the minute), converted into the broadcast's time zone. For a broadcast that sends in each contact's time zone, the time of day is read in the workspace's time zone and each contact receives it at that local time. Omit (or send an empty body) to dispatch immediately. Example: 2026-01-31T12:00:00Z

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

### `clickfunnels_broadcast_test_send`

Send Test Broadcast · Write

Send the saved broadcast to 1 to 5 test recipients.
Returns an object with status, accepted_count.
Use clickfunnels_broadcast_test_send to preview a broadcast before clickfunnels_broadcast_send.

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

Inputs:

- `broadcast_id` (`string`, required): Broadcast ID (numeric id or public id). Example: 1234
- `recipients` (`array`, required): One email address per entry. Outer whitespace is trimmed; order and duplicates are preserved. Example: ["value"]
- `from_address_id` (`integer`, optional): Optional numeric or public ID from this workspace's valid preview senders. Omitted, null or blank uses the saved sender. Overrides cannot repair an ineligible broadcast. Example: 12345
- `subject` (`string`, optional): Optional test-only subject with valid Liquid. Omitted, null or blank uses the saved subject. Example: Q4 renewal

Example input: `{"broadcast_id":"<broadcast_id>","recipients":["value"]}`

### `clickfunnels_broadcast_update`

Update Email Broadcast · Write

Update a draft email broadcast.
Returns an object with id, public_id, workspace_id, name, subject, preheadline, status, origination_channel_type, origination_channel_id, external_id, and more.
Use clickfunnels_broadcast_update to change a draft before sending.

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

Inputs:

- `broadcast_id` (`string`, required): Broadcast ID (numeric id or public id). Example: 1234
- `external_id` (`string`, optional): An optional external identifier for your own tracking. Example: abc123
- `filter_id` (`string`, optional): Contact filter for the broadcast audience. Accepts any of three forms: the numeric id or the public id (string) of a saved contact filter (Refine::StoredFilter) in this workspace, or a serialized contact filter. The supplied filter is copied onto the broadcast — the broadcast points at its own copy, so later edits to (or deletion of) the saved filter never change this broadcast's audience. Example: abc123
- `from_email` (`string`, optional): Sender email address. Must be a verified email address that belongs to the workspace. Example: jane@example.com
- `html_body` (`string`, optional): HTML email body. Example: example
- `name` (`string`, optional): Internal name for the broadcast. Example: Example name
- `preheadline` (`string`, optional): Preview text shown in email clients before opening. Maximum 150 characters. Example: example
- `reply_to_email` (`string`, optional): Reply-to email address. Must be a verified address in the workspace if provided. Example: jane@example.com
- `send_at` (`string`, optional): Scheduled send date. Example: 2026-01-31T12:00:00Z
- `send_at_local_time` (`string`, optional): Scheduled send time in HH:MM:SS format. Example: example
- `send_immediately` (`boolean`, optional): Whether the broadcast is set to send immediately rather than at its scheduled date and time. Setting it to false requires send_at (in this request or already on the broadcast). Creating a send action overrides this either way - see createEmailsBroadcastsSendActions. Example: true
- `smart_sending` (`boolean`, optional): Smart Sending. When true the broadcast is delivered gradually across a window rather than all at once, which protects deliverability. A broadcast is created with this on, so send false to deliver the whole audience in one go. Above 5,000 recipients Smart Sending is mandatory: sending false is accepted and may be stored as true. The send batches at that size regardless of the stored value. Example: true
- `smart_sending_time` (`number`, optional): How many smart_sending_units the delivery window spans, for example 2 with hour. Must be between 0.5 and 100, and must be sent together with smart_sending_unit. Send both as null to go back to sizing the window from the audience. Example: 10
- `smart_sending_unit` (`string`, optional): The unit of the Smart Sending delivery window. Must be sent together with smart_sending_time. Send both as null to go back to sizing the window from the audience. One of: hour, day. Example: hour. One of: `hour`, `day`.
- `split_test` (`boolean`, optional): Enable or disable the subject-line split test. Disabling preserves variant B and the stored test settings for later editing. Must be a JSON boolean - string spellings such as "true" return 422. Example: true
- `split_test_percentage` (`integer`, optional): Whole-number share of the audience used for the test sends. Omit to preserve the stored value. Example: 10
- `split_test_wait_time` (`integer`, optional): Whole hours to wait before choosing the subject-line winner. Omit to preserve the stored value. Example: 10
- `subject` (`string`, optional): Email subject line seen by recipients. Example: Q4 renewal
- `template_id` (`integer`, optional): Numeric id of an existing email template in this workspace to point this draft broadcast at (swaps the referenced template). Takes precedence over an inline html_body/text_body. Only draft broadcasts can be updated; an unknown id returns 422. Example: 12345
- `text_body` (`string`, optional): Plain text email body. Example: example
- `time_zone` (`string`, optional): Time zone for scheduling. Example: America/New_York
- `topic_ids` (`array`, optional): Topic IDs to associate. Example: [1, 2]
- `variants` (`array`, optional): Omit to preserve variant B, send one entry to replace B, or send an empty array to remove B while split_test is false. The top-level subject and preheadline remain variant A. Example: [{"key": "value"}]

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

### `clickfunnels_contact_create`

Create Contact · Write

Create a contact in a workspace.
Returns an object with id, public_id, workspace_id, default_shipping_address_id, anonymous, email_address, first_name, last_name, phone_number, time_zone, and more.
Use clickfunnels_contact_create for a new contact. Use clickfunnels_contact_upsert to create or update by email.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `custom_attributes` (`object`, optional): Custom attribute values as an object of attribute name to value. Example: {"plan": "pro"}
- `email_address` (`string`, optional): Email address. Example: jane@example.com
- `fb_url` (`string`, optional): Facebook URL. Example: https://example.com
- `first_name` (`string`, optional): First name. Example: Jane
- `instagram_url` (`string`, optional): Instagram URL. Example: https://example.com
- `last_name` (`string`, optional): Last name. Example: Doe
- `linkedin_url` (`string`, optional): LinkedIn URL. Example: https://example.com
- `phone_number` (`string`, optional): Phone number. Example: +15555550101
- `tag_ids` (`array`, optional): Contact tag IDs to apply. Example: [101, 102]
- `time_zone` (`string`, optional): The human-readable time zone, usually set dynamically by the app for the contact, for example, during opt-in. Read more about time zones and how to map them back to the TZ standard in our Time Zones guide.. Example: America/New_York
- `twitter_url` (`string`, optional): Twitter URL. Example: https://example.com
- `website_url` (`string`, optional): Website URL. Example: https://example.com

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

### `clickfunnels_contact_note_create`

Add Contact Note · Write

Add a note to a contact's activity tab.
Returns an object with id, public_id, contact_id, content, created_by_id, occurred_at, created_at, updated_at.
Use clickfunnels_contact_note_create to log a call or remark on a contact.

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

Inputs:

- `contact_id` (`string`, required): Contact ID. Example: 1234
- `content` (`string`, required): Required nonblank text on creation; no length cap. Example: Called to confirm the renewal.
- `occurred_at` (`string`, optional): Optional ISO 8601 timestamp. Defaults to server time on creation; omission on update preserves its occurrence time. Example: 2026-01-31T12:00:00Z

Example input: `{"contact_id":"<contact_id>","content":"<content>"}`

### `clickfunnels_contact_tag_apply`

Tag Contact · Write

Apply a tag to a contact.
Returns an object with id, public_id, contact_id, tag_id, created_at, updated_at, tag, contact.
Use clickfunnels_contact_tag_apply to tag one contact. Use clickfunnels_contact_tag_remove to remove it.

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

Inputs:

- `contact_id` (`string`, required): Contact ID. Example: 1234
- `tag_id` (`integer`, required): Contact tag ID from clickfunnels_tags_list. Example: 101

Example input: `{"contact_id":"<contact_id>","tag_id":101}`

### `clickfunnels_contact_update`

Update Contact · Write

Update a contact.
Returns an object with id, public_id, workspace_id, default_shipping_address_id, anonymous, email_address, first_name, last_name, phone_number, time_zone, and more.
Use clickfunnels_contact_update to change fields of a contact you know the ID of.

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

Inputs:

- `contact_id` (`string`, required): Contact ID (numeric id or public id). Example: 1234
- `custom_attributes` (`object`, optional): Custom attribute values as an object. Example: {"plan": "pro"}
- `email_address` (`string`, optional): Email address. Example: jane@example.com
- `fb_url` (`string`, optional): Facebook URL. Example: https://example.com
- `first_name` (`string`, optional): First name. Example: Jane
- `instagram_url` (`string`, optional): Instagram URL. Example: https://example.com
- `last_name` (`string`, optional): Last name. Example: Doe
- `linkedin_url` (`string`, optional): LinkedIn URL. Example: https://example.com
- `phone_number` (`string`, optional): Phone number. Example: +15555550101
- `tag_ids` (`array`, optional): Contact tag IDs; replaces the current tags. Example: [101, 102]
- `time_zone` (`string`, optional): The human-readable time zone, usually set dynamically by the app for the contact, for example, during opt-in. Read more about time zones and how to map them back to the TZ standard in our Time Zones guide.. Example: America/New_York
- `twitter_url` (`string`, optional): Twitter URL. Example: https://example.com
- `website_url` (`string`, optional): Website URL. Example: https://example.com

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

### `clickfunnels_contact_upsert`

Upsert Contact · Write

Create a contact, or update the existing one with the same email address.
Returns an object with id, public_id, workspace_id, default_shipping_address_id, anonymous, email_address, first_name, last_name, phone_number, time_zone, and more.
Use clickfunnels_contact_upsert to sync contacts from another system by email.

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

Inputs:

- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `custom_attributes` (`object`, optional): Custom attribute values as an object. Example: {"plan": "pro"}
- `email_address` (`string`, optional): Email address to match on. Example: jane@example.com
- `fb_url` (`string`, optional): Facebook URL. Example: https://example.com
- `first_name` (`string`, optional): First name. Example: Jane
- `instagram_url` (`string`, optional): Instagram URL. Example: https://example.com
- `last_name` (`string`, optional): Last name. Example: Doe
- `linkedin_url` (`string`, optional): LinkedIn URL. Example: https://example.com
- `phone_number` (`string`, optional): Phone number. Example: +15555550101
- `tag_ids` (`array`, optional): Contact tag IDs to apply. Example: [101, 102]
- `time_zone` (`string`, optional): The human-readable time zone, usually set dynamically by the app for the contact, for example, during opt-in. Read more about time zones and how to map them back to the TZ standard in our Time Zones guide.. Example: America/New_York
- `twitter_url` (`string`, optional): Twitter URL. Example: https://example.com
- `website_url` (`string`, optional): Website URL. Example: https://example.com

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

### `clickfunnels_course_enrollment_create`

Enroll Contact in Course · Write

Give a contact access to a course.
Returns an object with id, public_id, contact_id, course_id, created_at, updated_at, suspended, suspension_reason, current_path, origination_source_type, and more.
Use clickfunnels_course_enrollment_create to enroll one contact.

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

Inputs:

- `contact_id` (`integer`, required): Contact ID to enroll. Example: 5678
- `course_id` (`string`, required): Course ID. Example: 1234
- `suspended` (`boolean`, optional): Suspended. Example: true
- `suspension_reason` (`string`, optional): Suspension Reason. Example: example

Example input: `{"contact_id":5678,"course_id":"<course_id>"}`

### `clickfunnels_opportunity_create`

Create Opportunity · Write

Create a sales opportunity for a contact in a pipeline stage.
Returns an object with id, public_id, name, workspace_id, pipeline_id, pipelines_stage_id, primary_contact_id, value, sort_order, closed_at, and more.
Use clickfunnels_opportunity_create to add a deal.

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

Inputs:

- `name` (`string`, required): Name. Example: Example name
- `pipelines_stage_id` (`integer`, required): Pipeline Stage. Example: 12345
- `primary_contact_id` (`integer`, required): Primary Contact. Example: 12345
- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `assignee_id` (`integer`, optional): The ID of the Team Membership to assign the Opportunity to. An Opportunity can be assigned to any Team member since they have access to all your workspaces. You can get a list of available Memberships and their id via the Team resource's memberships property. If the opportunity is already assigned to a team member, the assignee will be updated. You can unset the assignee by passing a null value for assignee_id. Example: 12345
- `closed_at` (`string`, optional): Close date. Example: 2026-01-31T12:00:00Z
- `value` (`number`, optional): The potential value of this opportunity in the default currency of the workspace. Example: 10

Example input: `{"name":"<name>","pipelines_stage_id":12345,"primary_contact_id":12345,"workspace_id":"<workspace_id>"}`

### `clickfunnels_opportunity_update`

Update Opportunity · Write

Update a sales opportunity, for example to move it to another stage or change its value.
Returns an object with id, public_id, name, workspace_id, pipeline_id, pipelines_stage_id, primary_contact_id, value, sort_order, closed_at, and more.
Use clickfunnels_opportunity_update to progress a deal.

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

Inputs:

- `opportunity_id` (`string`, required): Opportunity ID (numeric id or public id). Example: 1234
- `assignee_id` (`integer`, optional): The ID of the Team Membership to assign the Opportunity to. An Opportunity can be assigned to any Team member since they have access to all your workspaces. You can get a list of available Memberships and their id via the Team resource's memberships property. If the opportunity is already assigned to a team member, the assignee will be updated. You can unset the assignee by passing a null value for assignee_id. Example: 12345
- `closed_at` (`string`, optional): Close date. Example: 2026-01-31T12:00:00Z
- `name` (`string`, optional): Name. Example: Example name
- `pipelines_stage_id` (`integer`, optional): Pipeline Stage ID. Example: 12345
- `primary_contact_id` (`integer`, optional): Primary Contact ID. Example: 12345
- `value` (`number`, optional): The potential value of this opportunity in the default currency of the workspace. Example: 10

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

### `clickfunnels_product_create`

Create Product · Write

Create a product in a workspace.
Returns an object with id, public_id, workspace_id, name, current_path, archived, visible_in_store, visible_in_customer_center, image_id, seo_title, and more.
Use clickfunnels_product_create for a new product, then add prices to its variant.

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

Inputs:

- `name` (`string`, required): Product name. Example: Example name
- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `cancellation_funnel_url` (`string`, optional): Cancellation Funnel Url. Example: https://example.com
- `commissionable` (`boolean`, optional): Commissionable. Example: true
- `current_path` (`string`, optional): Current Path. Example: example
- `image_ids` (`array`, optional): Images. Example: ["abc123"]
- `redirect_funnel_id` (`string`, optional): Redirect funnel. Example: abc123
- `seo_description` (`string`, optional): A clear SEO description, at least two sentences long. Longer is better, but max is 160 characters. You will find the actual user-facing description on the default variant of the product (see the Products::Variant resource). Example: example
- `seo_image_id` (`string`, optional): SEO image. Example: abc123
- `seo_title` (`string`, optional): A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters. Example: example
- `tag_ids` (`array`, optional): Any valid array, empty or with valid tag ids will overwrite existing values. To avoid losing existing tags first use the Fetch Product endpoint, then be sure to include the existing tags in your payload along with any new addition(s) Example: [1, 2]
- `variant_properties` (`array`, optional): The properties of the product's variants. e.g. 'Size', 'Color' etc. Example: [{"key": "value"}]
- `visible_in_customer_center` (`boolean`, optional): Visible in Customer Center. Example: true
- `visible_in_store` (`boolean`, optional): Visible in Store. Example: true

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

### `clickfunnels_product_update`

Update Product · Write

Update a product.
Returns an object with id, public_id, workspace_id, name, current_path, archived, visible_in_store, visible_in_customer_center, image_id, seo_title, and more.
Use clickfunnels_product_update to change product details.

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

Inputs:

- `product_id` (`string`, required): Product ID (numeric id or public id). Example: 1234
- `cancellation_funnel_url` (`string`, optional): Cancellation Funnel Url. Example: https://example.com
- `commissionable` (`boolean`, optional): Commissionable. Example: true
- `current_path` (`string`, optional): Current Path. Example: example
- `image_ids` (`array`, optional): Images. Example: ["abc123"]
- `name` (`string`, optional): Product name. Example: Example name
- `price_ids` (`array`, optional): Price IDs. Example: ["abc123"]
- `redirect_funnel_id` (`string`, optional): Redirect funnel. Example: abc123
- `seo_description` (`string`, optional): A clear SEO description, at least two sentences long. Longer is better, but max is 160 characters. You will find the actual user-facing description on the default variant of the product (see the Products::Variant resource). Example: example
- `seo_image_id` (`string`, optional): SEO image. Example: abc123
- `seo_title` (`string`, optional): A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters. Example: example
- `tag_ids` (`array`, optional): Any valid array, empty or with valid tag ids will overwrite existing values. To avoid losing existing tags first use the Fetch Product endpoint, then be sure to include the existing tags in your payload along with any new addition(s) Example: [1, 2]
- `variant_ids` (`array`, optional): Variant IDs. Example: ["abc123"]
- `variant_properties` (`array`, optional): The properties of the product's variants. e.g. 'Size', 'Color' etc. Example: [{"key": "value"}]
- `visible_in_customer_center` (`boolean`, optional): Visible in Customer Center. Example: true
- `visible_in_store` (`boolean`, optional): Visible in Store. Example: true

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

### `clickfunnels_tag_create`

Create Contact Tag · Write

Create a contact tag in a workspace.
Returns an object with id, public_id, workspace_id, name, color, created_at, updated_at.
Use clickfunnels_tag_create before tagging contacts with a new tag.

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

Inputs:

- `name` (`string`, required): Tag name. Example: VIP
- `workspace_id` (`string`, required): Workspace ID (numeric id or public id), from clickfunnels_team_workspaces_list. Example: 42000
- `color` (`string`, optional): Tag colour as a hex code. Example: #3b82f6

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

### `clickfunnels_broadcast_delete`

Delete Email Broadcast · Destructive

Delete a draft email broadcast.
Returns the JSON response from the API.
Use clickfunnels_broadcast_delete to discard a draft.

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

Inputs:

- `broadcast_id` (`string`, required): Broadcast ID (numeric id or public id). Example: 1234

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

### `clickfunnels_contact_delete`

Delete Contact · Destructive

Delete a contact (soft delete: it disappears from lists and filters).
Returns the JSON response from the API.
Use clickfunnels_contact_delete to remove a contact.

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

Inputs:

- `contact_id` (`string`, required): Contact ID (numeric id or public id). Example: 1234

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

### `clickfunnels_contact_tag_remove`

Untag Contact · Destructive

Remove a tag from a contact by deleting the applied tag record.
Returns the JSON response from the API.
Use clickfunnels_contact_tag_remove with an ID from clickfunnels_contact_tags_list.

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

Inputs:

- `applied_tag_id` (`string`, required): Applied tag ID from clickfunnels_contact_tags_list. Example: 5678

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

### `clickfunnels_opportunity_delete`

Delete Opportunity · Destructive

Delete a sales opportunity.
Returns the JSON response from the API.
Use clickfunnels_opportunity_delete to remove a deal.

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

Inputs:

- `opportunity_id` (`string`, required): Opportunity ID (numeric id or public id). Example: 1234

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

## Related

Other Marketing connectors ([all 190](/agentkit/connectors/?category=marketing)):

- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twitter / X](/agentkit/connectors/twitteroauth/): Scalekit connector, OAuth, 92 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 |
