# ClickFunnels integration

> Sales funnel platform API for contacts, funnels, pages, orders, products, courses, forms, email broadcasts, sales pipelines, and webhooks.

- Authentication: apiKey

## Tools (292)

- **Archive a Product**: This will archive a Product. A product can only be archived if it's not in the "live" state.
- **Archive Email Topic**: Archive an email topic. System topics cannot be archived.
- **Cancel a Fulfillment**: This will cancel a Fulfillment. A Fulfillment can only be cancelled when it's in a "fulfilled" state. The "cancelled" state is final.
- **Change Variant/Price**: Commits a variant/price change for a subscription line item. The change must be an allowed upgrade or downgrade option on the source variant.
- **Create Answer**: Add a new answer to a submission
- **Create Applied Tag (Contacts AppliedTag)**: Assign a tag to a contact by creating an applied tag
- **Create Applied Tag (Orders AppliedTag)**: Assign a tag to an order by creating an applied tag
- **Create Blog Post**: Create a new post within the given blog. Pass `markup` to set the post's visual content via PML. Invalid markup returns 400 and the post is not created. Pass `expand[]=markup` to have the markup returned in the response.
- **Create Blog Tag**: Create a new tag within the given blog.
- **Create Collection**: Create a product collection in a workspace
- **Create Conditional Split Step**: Add a new conditional split step to a funnel. All fields are optional — providing none creates an empty unconfigured split.
- **Create Contact**: Add a new contact to the workspace
- **Create Email Broadcast**: Create a new email broadcast. Broadcasts are created in draft status. Provide recipients and set send_immediately to true to send right away, or schedule with send_at, send_at_local_time, and time_zone.
- **Create Email Template**: Create an email template from html_body/text_body. The template is marked api-created and is hidden from the visual template pickers (it cannot be edited in the visual BeeFree editor).
- **Create Email Topic**: Create a new email topic for a workspace
- **Create Endpoint**: Add a new webhook endpoint to a workspace
- **Create Enrollment**: Add a new enrollment
- **Create External Invoice**: Create an invoice for an external order. Useful if you process payments outside of ClickFunnels but still want to use ClickFunnels' automations and funnels.
- **Create External Order**: Create a new external order in the current workspace. Useful if you process payments outside of ClickFunnels but still want to use ClickFunnels' automations and funnels.
- **Create External Page**: Closed Alpha — create an externally-hosted (SDK) page in a funnel. The visual content lives on your own domain and is registered with ClickFunnels via a lightweight SDK integration.
- **Create Field**: Add a new field
- **Create Field Set**: Add a new field set
- **Create Form**: Add a new form
- **Create Fulfillment**: Fulfill an order or a part of an order.
- **Create Funnel**: Create a new funnel in the workspace. Creating a funnel automatically creates a workflow; add pages by creating pages with funnel.funnel_id set to the new funnel's ID.
- **Create Image**: Upload an image to a workspace from a source URL
- **Create Lesson Completion**: Mark a lesson as completed by a specific enrollment. You can only mark a lesson as completed once. Subsequent completions for the same lesson by the same enrollment will return a conflict error.
- **Create Location**: Create a fulfillment location for a workspace
- **Create Name**: Add a new rate name to a shipping profile
- **Create Note**: Create a note on a sales opportunity
- **Create Opportunity**: Create a sales opportunity in a workspace
- **Create Option**: Add a new option to a field
- **Create Package**: Add a new shipping package to a workspace
- **Create Page**: Create a new internal page in the workspace. Without funnel references it creates a standalone landing page; attach to a funnel via funnel.funnel_id or funnel.show_page_step_id.
- **Create Pipeline**: Create a sales pipeline in a workspace
- **Create Price**: Create a new price for a given variant.
- **Create Product**: Add a new product to a workspace
- **Create Profile**: Add a new shipping profile to a workspace
- **Create Rate**: Add a new shipping rate to a zone
- **Create Refine Filter**: Create a new RefineFilter in the workspace. The criteria array must contain at least one entry.
- **Create Split Test Step**: Wrap an existing page in a new split test. Provide one variant to wrap a single page, or two variants to wrap a page and attach a fresh page as the second branch.
- **Create Stage**: Create a stage in a sales pipeline
- **Create Step**: Closed Beta — add a new step to a workflow. step_type_settings must contain exactly one key naming the step type.
- **Create Store**: Create a store in a workspace
- **Create Submission**: Add a new submission to a form
- **Create Tag (Contacts Tag)**: Add a new Contact Tag to your Workspace
- **Create Tag (Funnels Tag)**: Create a funnel tag in a workspace
- **Create Tag (Orders Tag)**: Add a new order tag to your workspace
- **Create Tag (Products Tag)**: Add a new tag to a product
- **Create Trigger**: Closed Beta — add a new trigger to a workflow. The event_type_key must be a valid workflow trigger event key.
- **Create Variant**: Create a new variant for a product
- **Create Workflow**: Closed Beta — create a new standalone automation workflow. New workflows are created in the draft state (disabled).
- **Create Zone**: Add a new zone to a location group
- **Delete Blog Post**: Delete a blog post. This is a hard delete; the post and its associated authorships, taggings, applied categories, and publish actions are removed.
- **Delete Email Broadcast**: Delete an email broadcast. Only broadcasts in draft status can be deleted.
- **Delete Email Template**: Delete an email template. Returns 422 if the template is shared or is in use by a workflow send-email step.
- **Delete Page**: Delete a page by ID. Works for both internal and external (SDK) pages.
- **Delete Step**: Closed Beta — delete a step from a workflow. Split steps and their branch contents are removed recursively.
- **Delete Trigger**: Closed Beta — delete a trigger from a workflow.
- **Delete Workflow**: Closed Beta — permanently delete a workflow and all its associated triggers, steps, and run records.
- **Destroy Conditional Split Step**: Remove a conditional split from the funnel. Any value of branch collapses the entire split; a single-branch value promotes the other branch's pages up under the split's parent.
- **Destroy Refine Filter**: Delete a RefineFilter. Detach the filter from all consumers before deleting.
- **Destroy Split Test Step**: Remove a split test from the funnel. Any value of branch collapses the entire split; a single-branch value promotes the other branch's pages up under the split's parent.
- **Disable Workflow**: Closed Beta — disable a workflow, stopping new runs from being started. In-progress runs are canceled.
- **Enable Workflow**: Closed Beta — enable a workflow so it can accept new runs. The workflow must have at least one active trigger.
- **Enroll Contact (Create Run)**: Closed Beta — manually enroll a contact into a workflow, starting a new run immediately. The workflow must be enabled (status: live).
- **Fetch Answer**: Retrieve an answer for a submission
- **Fetch Applied Tag (Contacts AppliedTag)**: Retrieve an applied tag for a contact
- **Fetch Applied Tag (Orders AppliedTag)**: Retrieve an applied tag for an order
- **Fetch Blog**: Retrieve a blog.
- **Fetch Blog Post**: Retrieve a blog post.
- **Fetch Blog Tag**: Retrieve a blog tag.
- **Fetch Collection**: Retrieve a product collection
- **Fetch Conditional Split Step**: Fetch a single conditional split step with its branches and condition.
- **Fetch Contact**: Retrieve a contact
- **Fetch Course**: Retrieve a course
- **Fetch Domain**: Fetch a single domain by ID.
- **Fetch Email Address**: Retrieve a single email address by ID
- **Fetch Email Broadcast**: Retrieve a single email broadcast by ID
- **Fetch Email Template**: Retrieve a single email template
- **Fetch Email Topic**: Retrieve a single email topic
- **Fetch Endpoint**: Retrieve a webhook endpoint for a workspace
- **Fetch Enrollment**: Retrieve an enrollment
- **Fetch Event**: Retrieve a webhook event for a workspace
- **Fetch Field**: Retrieve a form field
- **Fetch Field Set**: Retrieve a field set
- **Fetch Form**: Retrieve a form
- **Fetch Form Submission**: Retrieve a form submission record, including the submitted standard and custom fields.
- **Fetch Fulfillment**: Retrieve a specific fulfillment in the current workspace
- **Fetch Funnel**: Retrieve a funnel
- **Fetch Funnel Stats**: Retrieve detailed statistics for a funnel: key metrics summary and optional per-step breakdowns of views, opt-ins, sales, and earnings.
- **Fetch Funnel Structure**: Closed Beta — a funnel's steps as a single, flat, ordered list, the same top-to-bottom flow shown in the funnel builder.
- **Fetch Image**: Retrieve an image
- **Fetch Invoice**: Retrieve an invoice for an order.
- **Fetch Lesson**: Retrieve a course lesson
- **Fetch Lesson Completion**: Retrieve an enrollment-lesson completion record
- **Fetch Location**: Retrieve a fulfillment location
- **Fetch Location Group**: Retrieve a shipping location group
- **Fetch My User**: Returns the user data for the currently authenticated user, without needing the user ID. Includes optional data if the current user is a platform agent.
- **Fetch Name**: Retrieve a rate name for a shipping profile
- **Fetch Note**: Retrieve a note on a sales opportunity
- **Fetch Opportunity**: Retrieve a sales opportunity
- **Fetch Option**: Retrieve an option for a field
- **Fetch Order**: Retrieve a specific order in the current workspace.
- **Fetch Package**: Retrieve a shipping package for a workspace
- **Fetch Page**: Retrieve a page, including extra information such as funnel membership.
- **Fetch Page Stats**: Retrieve statistics for a page: views, opt-ins, sales, and earnings, computed from the page's associated funnel step.
- **Fetch Pipeline**: Retrieve a sales pipeline
- **Fetch Price**: Retrieve a single price
- **Fetch Product**: Retrieve a product for a workspace
- **Fetch Profile**: Retrieve a shipping profile for a workspace
- **Fetch Rate**: Retrieve a shipping rate for a zone
- **Fetch Refine Filter**: Fetch a single RefineFilter by its public id.
- **Fetch Restock**: Retrieve a restock record for an order invoice
- **Fetch Run**: Closed Beta — retrieve a single workflow run by its id or obfuscated public_id.
- **Fetch Section**: Retrieve a course section
- **Fetch Site**: Fetch the site for a workspace. Sites contain global code settings that apply to all pages and funnels.
- **Fetch Split Test Step**: Fetch a single split test step with its variants and weights.
- **Fetch Stage**: Retrieve a sales pipeline stage
- **Fetch Step**: Closed Beta — retrieve a single workflow step.
- **Fetch Store**: Retrieve a store
- **Fetch Submission**: Retrieve a submission for a form
- **Fetch Tag (Contacts Tag)**: Retrieve a single Contact Tag
- **Fetch Tag (Funnels Tag)**: Retrieve a funnel tag
- **Fetch Tag (Orders Tag)**: Retrieve a single order tag
- **Fetch Tag (Products Tag)**: Retrieve a tag for a product
- **Fetch Team**: Retrieve a single team
- **Fetch Theme**: Retrieve a theme
- **Fetch Transaction**: Retrieve a transaction for an order
- **Fetch Trigger**: Closed Beta — retrieve a single workflow trigger.
- **Fetch User**: Retrieve a single user
- **Fetch Variant**: Retrieve a single variant
- **Fetch Workflow**: Closed Beta — retrieve a single workflow by its integer id or obfuscated public_id.
- **Fetch Workflow Structure**: Closed Beta — returns the workflow's complete tree in a single call: header, active triggers, and the ordered list of visible steps with branching inlined.
- **Fetch Workspace**: Retrieve a workspace
- **Fetch Zone**: Retrieve a zone for a location group
- **Generate a Contact Filter**: Translates a natural-language audience description into a ClickFunnels contact filter using an AI model.
- **Get a Contact Filter**: Fetches a previously saved contact filter by id. The workspace is resolved from the filter itself.
- **Get Email Settings**: Retrieve email settings for a workspace
- **List Answers**: List answers for a submission
- **List Applied Tags (Contacts AppliedTag)**: List the applied tags for a contact
- **List Applied Tags (Orders AppliedTag)**: List the applied tags for an order
- **List Blog Posts**: List posts for the given blog.
- **List Blogs**: List blogs for the given workspace.
- **List Blog Tags**: List tags for the given blog.
- **List Collections**: List product collections for a workspace
- **List Conditional Split Steps**: List all conditional split steps in a funnel, each with its condition and 2-entry branches array.
- **List Contacts**: List contacts for the given workspace. By default, only identified contacts are shown (no anonymous or GDPR-redacted contacts).
- **List Courses**: List courses for a workspace
- **List Domains**: List all domains for a workspace. Use this to retrieve domain IDs for other resources such as Funnels.
- **List Email Addresses**: List all email addresses for a workspace
- **List Email Broadcasts**: List all email broadcasts for a workspace. Filterable by id and status.
- **List Email Templates**: List all email templates for a workspace
- **List Email Topics**: List all email topics for a workspace. Use include_archived=true to include archived topics.
- **List Endpoints**: List webhook endpoints for a workspace
- **List Enrollments**: List enrollments for a course
- **List Events**: List webhook events for a workspace
- **List Fields**: List fields for a field set
- **List Field Sets**: List field sets for a form
- **List Forms**: List forms for a workspace
- **List Form Submissions**: List all form submissions for the workspace, including the submitted standard and custom fields.
- **List Fulfillments**: List all fulfillments for your workspace.
- **List Funnels**: List funnels for a workspace
- **List Images**: List images for a workspace
- **List Invoices**: List invoices for a specific order.
- **List Lesson Completions**: List enrollment-completion records showing which lessons have been completed by which enrollments.
- **List Lessons**: List lessons for a course section. Ordered by id ascending by default.
- **List Location Groups**: List location groups for a shipping profile
- **List Locations**: List fulfillment locations for a workspace
- **List Names**: List rate names for a workspace's shipping profiles
- **List Notes**: List notes for a sales opportunity
- **List Opportunities**: List sales opportunities for a workspace
- **List Options**: List options for a field
- **List Orders**: List all orders for the current workspace.
- **List Packages**: List shipping packages for a workspace
- **List Pages**: List pages for a workspace, including funnel membership information.
- **List Pipelines**: List sales pipelines for a workspace
- **List Prices**: List all prices for a given product, including all prices for all variants. Filter by variant_id for a specific variant.
- **List Products**: List all products for a workspace
- **List Profiles**: List shipping profiles for a workspace
- **List Rates**: List shipping rates for a zone
- **List Refine Filters**: List all RefineFilters in a workspace, ordered by id ascending.
- **List Restocks**: List restock records for a workspace
- **List Runs**: Closed Beta — list automation runs for a workflow. Supports filtering by contact_id and status.
- **List Scheduled Events**: List appointment scheduled events for a workspace
- **List Sections**: List sections for a course. Ordered by id ascending by default; includes the course's root section container.
- **List Split Test Steps**: List all split test steps in a funnel. Each split test wraps an existing page in a two-branch split.
- **List Stages**: List stages for a sales pipeline
- **List Steps**: Closed Beta — list all visible steps for a workflow.
- **List Stores**: List stores for a workspace
- **List Styles**: List styles for a workspace
- **List Submissions**: List submissions for a form
- **List Tags (Contacts Tag)**: List all Contact Tags for your workspace
- **List Tags (Funnels Tag)**: List funnel tags for a workspace
- **List Tags (Orders Tag)**: List all order tags for your workspace
- **List Tags (Products Tag)**: List product tags for a workspace
- **List Teams**: List all teams for the current account. Usually the first discovery call after connecting.
- **List Themes**: List of all themes available in the workspace
- **List Transactions**: List transactions for an order
- **List Triggers**: Closed Beta — list all triggers attached to a workflow.
- **List Upgrade/Downgrade Options**: Returns the allowed upgrade and downgrade target variants for a price, grouped by target variant.
- **List Users**: List users for the current account. Scoped to the API's platform-agent user — not the way to enumerate human team members.
- **List Variants**: List variants for a product
- **List Workflows**: Closed Beta — list the standalone automation workflows for a workspace.
- **List Workspace Invoices**: List all invoices for a specific workspace.
- **List Workspaces**: List workspaces for a team
- **List Zones**: List zones for a location group
- **Preview Variant/Price Change**: Returns a non-destructive preview of changing the variant and price of a subscription line item, including proration math and the next charge amount.
- **Redact Contact**: Destroys all personally identifiable information for a contact (name, phone number) without deleting the contact record itself. This cannot be undone.
- **Remove Answer**: Delete an answer for a submission
- **Remove Applied Tag (Contacts AppliedTag)**: Remove a tag from a contact by deleting an applied tag
- **Remove Applied Tag (Orders AppliedTag)**: Remove a tag from an order by deleting an applied tag
- **Remove Contact**: Delete a contact
- **Remove Endpoint**: Delete a webhook endpoint for a workspace
- **Remove Field**: Delete a field
- **Remove Field Set**: Delete a field set
- **Remove Form**: Delete a form
- **Remove Fulfillment**: Delete a fulfillment
- **Remove Image**: Delete an image
- **Remove Lesson Completion**: Unmark a lesson as completed. This action deletes the record.
- **Remove Location**: Delete a fulfillment location
- **Remove Name**: Delete a rate name for a shipping profile
- **Remove Note**: Delete a note from a sales opportunity
- **Remove Opportunity**: Delete a sales opportunity
- **Remove Option**: Delete an option for a field
- **Remove Package**: Delete a shipping package for a workspace
- **Remove Products from Page**: Detach one or more products from the page's show page step — the only way to remove products from a page via the API.
- **Remove Profile**: Delete a shipping profile for a workspace
- **Remove Rate**: Delete a shipping rate for a zone
- **Remove Stage**: Delete a sales pipeline stage
- **Remove Store**: Delete a store
- **Remove Submission**: Delete a submission for a form
- **Remove Tag (Contacts Tag)**: Delete a Contact Tag from your workspace
- **Remove Tag (Funnels Tag)**: Delete a funnel tag
- **Remove Tag (Orders Tag)**: Delete an order tag from your workspace
- **Remove Tag (Products Tag)**: Delete a tag for a product
- **Remove Zone**: Delete a zone for a location group
- **Reorder Fields**: Reorders the fields of a field set.
- **Set Default Theme**: Set the specified theme as the default theme for the current workspace.
- **Unarchive a Product**: This will unarchive a Product.
- **Update Answer**: Update an answer for a submission
- **Update Blog**: Update a blog's metadata. Permitted fields: name, seo_title, seo_description, seo_image_id, theme_id.
- **Update Blog Post**: Update a blog post. Pass markup to update the post's visual content via PML.
- **Update Collection**: Update a product collection
- **Update Conditional Split Step**: Update the condition and/or attach pages to existing branches of a conditional split step.
- **Update Contact**: Update a contact
- **Update Email Broadcast**: Update an email broadcast. Only broadcasts in draft status can be updated.
- **Update Email Template**: Update an email template. Only the provided fields are changed. Invalid Liquid in html_body is rejected with 422.
- **Update Email Topic**: Update an email topic
- **Update Endpoint**: Update a webhook endpoint for a workspace
- **Update Enrollment**: Update an enrollment
- **Update External Invoice**: Update a specific invoice. Currently only invoices of external orders can be updated.
- **Update Field**: Update a field
- **Update Field Set**: Update a field set
- **Update Form**: Update a form
- **Update Fulfillment**: Update a specific fulfillment.
- **Update Funnel**: Update a funnel. Use head_code/footer_code to inject custom code; head_code_mode/footer_code_mode control append vs replace.
- **Update Image**: Update an image's metadata or re-upload from a source URL
- **Update Lesson**: Update a course lesson
- **Update Location**: Update a fulfillment location
- **Update Name**: Update a rate name for a shipping profile
- **Update Note**: Update a note on a sales opportunity
- **Update Opportunity**: Update a sales opportunity
- **Update Option**: Update an option for a field
- **Update Order**: Update a specific order in the current workspace. External orders have different updateable fields than orders with a regular payment processor.
- **Update Package**: Update a shipping package for a workspace
- **Update Page**: Update an existing page. Works for both internal and external (SDK) pages; field availability depends on page type.
- **Update Pipeline**: Update a sales pipeline
- **Update Price**: Update a single price
- **Update Product**: Update a product for a workspace
- **Update Profile**: Update a shipping profile for a workspace
- **Update Rate**: Update a shipping rate for a zone
- **Update Refine Filter**: Update an existing RefineFilter. All fields are optional — only provided fields are updated.
- **Update Section**: Update a course section
- **Update Site**: Update the site for a workspace. Use head_code/footer_code to inject custom code globally.
- **Update Split Test Step**: Update a split test's variants: attach a page to an empty branch, swap an existing variant's page, or adjust the weights.
- **Update Stage**: Update a sales pipeline stage
- **Update Step**: Closed Beta — update a workflow step's name, step_type_settings, and/or placement.
- **Update Store**: Update a store
- **Update Submission**: Update a submission for a form
- **Update Tag (Contacts Tag)**: Update a Contact Tag
- **Update Tag (Funnels Tag)**: Update a funnel tag
- **Update Tag (Orders Tag)**: Update an order tag
- **Update Tag (Products Tag)**: Update a tag for a product
- **Update Team**: Update a team's name, time zone, or locale
- **Update Theme**: Update a theme
- **Update Trigger**: Closed Beta — update an existing workflow trigger. All fields optional.
- **Update Variant**: Update a single variant
- **Update Workflow**: Closed Beta — update a workflow's name or archived flag. run_type is server-controlled and cannot be changed.
- **Update Workspace**: Update a workspace
- **Update Zone**: Update a zone for a location group
- **Upsert a Contact**: Creates or updates a Contact, matching on the email address.

## Triggers (2)

- **New Contact in ClickFunnels**: Triggers when a new contact is created in a ClickFunnels workspace (opt-in, purchase, or manual add). Contacts back-dated outside the poll window are missed.
- **New Order in ClickFunnels**: Triggers when a new order is created in a ClickFunnels workspace. Set the Billing status filter to "Paid" to react only to completed payments.

## Related prompts

- [New ClickFunnels sales to Slack and a Google Sheets ledger](https://www.generalinput.com/prompts/new-clickfunnels-sales-to-slack-and-a-google-sheets-ledger.md)
- [Auto-enrich ClickFunnels leads and brief your sales team](https://www.generalinput.com/prompts/auto-enrich-clickfunnels-leads-and-brief-your-sales-team.md)
- [Auto-sync ClickFunnels sales into QuickBooks Online](https://www.generalinput.com/prompts/auto-sync-clickfunnels-sales-into-quickbooks-online.md)
- [Weekly ClickFunnels performance report emailed to you](https://www.generalinput.com/prompts/weekly-clickfunnels-performance-report-emailed-to-you.md)

Connect ClickFunnels in General Input: https://www.generalinput.com/apps/clickfunnels