# ClickFunnels 2.0 Documentation > The CF2 API allows users to integrate with their ClickFunnels 2.0 accounts to interact with funnels, contacts, webhooks, and more. ## Guides: GETTING STARTED - [Welcome](https://developers.myclickfunnels.com/docs/intro.md): Introduction into the ClickFunnels API. - [Getting Started](https://developers.myclickfunnels.com/docs/getting-started.md): Making your first request. - [OAuth 2.0](https://developers.myclickfunnels.com/docs/oauth-20.md) - [SSO](https://developers.myclickfunnels.com/docs/sso.md): Authenticating ClickFunnels contacts from your platform via a JWT token. - [Integrate With Us](https://developers.myclickfunnels.com/docs/integrate-with-us.md) ## Guides: REST API - [Authentication](https://developers.myclickfunnels.com/docs/authentication.md) - [Rate Limiting](https://developers.myclickfunnels.com/docs/rate-limiting.md) - [Requests and Responses](https://developers.myclickfunnels.com/docs/requests-and-responses.md): Learn how the ClickFunnels API accepts requests and sends back responses - [Filtering](https://developers.myclickfunnels.com/docs/filtering.md): Learn all about ClickFunnels filters and common gotchas. - [Pagination](https://developers.myclickfunnels.com/docs/pagination.md) - [Time Zones](https://developers.myclickfunnels.com/docs/timezones.md): Everything you need to know about reading and passing time zones in the ClickFunnels API. - [Expand Responses](https://developers.myclickfunnels.com/docs/expand.md) - [Contact shipping and billing addresses](https://developers.myclickfunnels.com/docs/contact-addresses.md): Manage the shipping and billing addresses shown in a contact's overview from your integration ## Guides: Selling - [Orders Overview](https://developers.myclickfunnels.com/docs/orders.md): ClickFunnels orders enable customers to purchase products and subscriptions through funnels, manual orders and the public API. - [Fulfillments](https://developers.myclickfunnels.com/docs/fulfillments.md): Fulfillments allow fulfilling orders. - [Products](https://developers.myclickfunnels.com/docs/products.md) ## Guides: Funnels - [Filtering by page](https://developers.myclickfunnels.com/docs/filtering-by-page.md): Get the right page name or page ID that you want to filter for. - [Publishing funnel pages with the API](https://developers.myclickfunnels.com/docs/publishing-funnel-pages.md): Save page content through the existing Pages API and keep funnel payment mode separate. ## Guides: Webhooks - [How to Work with Webhooks](https://developers.myclickfunnels.com/docs/webhooks.md): Everything you need to get going with webhooks. - [Webhook Event Types](https://developers.myclickfunnels.com/docs/webhook-event-types.md): Understand the types of available webhook events and their data payloads. - [Signature Verification](https://developers.myclickfunnels.com/docs/signature-verification.md): Learn how to securely verify signatures of webhook events that you receive from ClickFunnels. ## Guides: OTHER INTEGRATIONS - [No-Code and Low-Code](https://developers.myclickfunnels.com/docs/no-code-and-low-code.md): You don't need code for all your business automations. ## API Reference: ClickFunnels API - Team - [List Teams](https://developers.myclickfunnels.com/reference/listteams.md): List all teams for the current account - [Fetch Team](https://developers.myclickfunnels.com/reference/fetchteam.md): Retrieve a single team - [Update Team](https://developers.myclickfunnels.com/reference/updateteam.md): List all teams for the current account - User - [List Users](https://developers.myclickfunnels.com/reference/listusers.md): List users for the current account. Note: an OAuth/API integration authenticates as a **platform-agent user** (e.g. "Default API Client"), so this endpoint is scoped to that agent and typically… - [Fetch User](https://developers.myclickfunnels.com/reference/fetchuser.md): Retrieve a single user - [Fetch My User](https://developers.myclickfunnels.com/reference/fetchmyuser.md): This endpoint returns the user data for the currently authenticated user. It is useful for quickly retrieving user information without knowing the user ID. It also includes optional data if the… - Workspace - [List Workspaces](https://developers.myclickfunnels.com/reference/listworkspaces.md): List workspaces for a team - [Fetch Workspace](https://developers.myclickfunnels.com/reference/getworkspaces.md): Retrieve a workspace - [Update Workspace](https://developers.myclickfunnels.com/reference/updateworkspaces.md): Update a workspace - [Fetch Workspace Stats](https://developers.myclickfunnels.com/reference/getworkspacestats.md): Aggregate statistics over a **filtered set of records, without listing the records**. Use this for any "how many", "what's the breakdown", or "what's the total" question: it is dramatically cheaper… - Site - [Fetch Site](https://developers.myclickfunnels.com/reference/getsite.md): Fetch the site for a workspace. Sites contain global code settings that apply to all pages and funnels. - [Update Site](https://developers.myclickfunnels.com/reference/updatesite.md): Update the site for a workspace. You can use head_code and footer_code parameters to inject custom code. Use head_code_mode and footer_code_mode to control whether code is appended or replaced. - Contacts::BillingAddress - [Get contact billing address](https://developers.myclickfunnels.com/reference/getcontactsbillingaddress.md): Read the billing address shown in the contact overview. Accepts the contact's numeric or public ID. Returns 404 if the contact has no billing address or is inaccessible. - [Create contact billing address](https://developers.myclickfunnels.com/reference/createcontactsbillingaddress.md): Create the contact's billing address, also shown in the contact overview. The contact in the URL owns the address. A second create returns 422; use PATCH on this URL to change it. Saving syncs Stripe… - [Update contact billing address](https://developers.myclickfunnels.com/reference/updatecontactsbillingaddress.md): Partially update the contact's existing billing address in place. Returns 404 if none is set. Changes sync Stripe customers and billing details on non-terminal Stripe orders. This does not replace a… - Shipping::Address - [List shipping addresses](https://developers.myclickfunnels.com/reference/listshippingaddresses.md): listShippingAddresses - [Create shipping addresses](https://developers.myclickfunnels.com/reference/createshippingaddresses.md): createShippingAddresses - [Get shipping addresses](https://developers.myclickfunnels.com/reference/getshippingaddresses.md): getShippingAddresses - [Update shipping addresses](https://developers.myclickfunnels.com/reference/updateshippingaddresses.md): updateShippingAddresses - [Remove shipping addresses](https://developers.myclickfunnels.com/reference/removeshippingaddresses.md): Deletes the entry and its street row. Deleting the default clears the contact pointer with no promotion. New orders retain the existing fallback to the newest remaining shipping entry. - Addresses::Country - [List Countries](https://developers.myclickfunnels.com/reference/listaddressescountries.md): List all countries, each with its ISO 3166-1 alpha-2 code (iso2). Use a country's iso2 as the country_code when setting an address, and as the {country_id} path segment when listing its regions. - [Get Country](https://developers.myclickfunnels.com/reference/getaddressescountries.md): Retrieve a single country by its ISO 3166-1 alpha-2 code. - Addresses::Region - [List Country Regions](https://developers.myclickfunnels.com/reference/listaddressescountriesregions.md): List the regions (states/provinces) of a country. Use a region's `code` or `name` as the address `region` value. Many countries have no regions. - Appointments::ScheduledEvent - [List Scheduled Events](https://developers.myclickfunnels.com/reference/listappointmentsscheduledevents.md): List Scheduled Events - Blog - [List Blogs](https://developers.myclickfunnels.com/reference/listblogs.md): List blogs for the given workspace. - [Fetch Blog](https://developers.myclickfunnels.com/reference/getblog.md): Retrieve a blog. - [Update Blog](https://developers.myclickfunnels.com/reference/updateblog.md): Update a blog's metadata. Permitted fields: `name`, `seo_title`, `seo_description`, `seo_image_id`, `theme_id`. See [Update blog… - Blogs::Author - [List Blog Authors](https://developers.myclickfunnels.com/reference/listblogsauthors.md): List the authors within the given blog. - [Fetch Blog Author](https://developers.myclickfunnels.com/reference/getblogauthor.md): Retrieve a blog author. - Blogs::Category - [List Blog Categories](https://developers.myclickfunnels.com/reference/listblogscategories.md): List the categories within the given blog. - [Fetch Blog Category](https://developers.myclickfunnels.com/reference/getblogcategory.md): Retrieve a blog category. - Blogs::Post - [List Blog Posts](https://developers.myclickfunnels.com/reference/listblogsposts.md): List posts for the given blog. When importing content from an external source, page through this list first so you do not create a duplicate post, see [Discover the destination and check for… - [Create Blog Post](https://developers.myclickfunnels.com/reference/createblogpost.md): 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… - [Fetch Blog Post](https://developers.myclickfunnels.com/reference/getblogpost.md): Retrieve a blog post. - [Update Blog Post](https://developers.myclickfunnels.com/reference/updateblogpost.md): Update a blog post. Pass `markup` to update the post's visual content via PML. It replaces the whole body, and PML covers only a subset of what the ClickFunnels editor can build, so if this post… - [Delete Blog Post](https://developers.myclickfunnels.com/reference/deleteblogpost.md): Delete a blog post. This is a hard delete; the post and its associated authorships, taggings, applied categories, and publish actions are removed. Deleting example or stock posts while migrating… - Blogs::Tag - [List Blog Tags](https://developers.myclickfunnels.com/reference/listblogstags.md): List tags for the given blog. - [Create Blog Tag](https://developers.myclickfunnels.com/reference/createblogtag.md): Create a new tag within the given blog. - [Fetch Blog Tag](https://developers.myclickfunnels.com/reference/getblogtag.md): Retrieve a blog tag. - Community - [List Communities](https://developers.myclickfunnels.com/reference/listcommunities.md): List communities for a workspace - [Create Community](https://developers.myclickfunnels.com/reference/createcommunities.md): Create a community for a workspace - [Fetch Community](https://developers.myclickfunnels.com/reference/getcommunities.md): Retrieve a community - [Update Community](https://developers.myclickfunnels.com/reference/updatecommunities.md): Update a community - Communities::SpaceGroup - [List Space Groups](https://developers.myclickfunnels.com/reference/listcommunitiesspacegroups.md): List space groups for a community - [Create Space Group](https://developers.myclickfunnels.com/reference/createcommunitiesspacegroups.md): Create a space group within a community - [Fetch Space Group](https://developers.myclickfunnels.com/reference/getcommunitiesspacegroups.md): Retrieve a space group - [Update Space Group](https://developers.myclickfunnels.com/reference/updatecommunitiesspacegroups.md): Update a space group - [Remove Space Group](https://developers.myclickfunnels.com/reference/removecommunitiesspacegroups.md): Delete a space group - Communities::Space - [List Spaces](https://developers.myclickfunnels.com/reference/listcommunitiesspaces.md): List spaces within a space group - [Create Space](https://developers.myclickfunnels.com/reference/createcommunitiesspaces.md): Create a space within a space group - [Fetch Space](https://developers.myclickfunnels.com/reference/getcommunitiesspaces.md): Retrieve a space - [Update Space](https://developers.myclickfunnels.com/reference/updatecommunitiesspaces.md): Update a space - [Remove Space](https://developers.myclickfunnels.com/reference/removecommunitiesspaces.md): Delete a space - Communities::Spaces::Post - [List Posts](https://developers.myclickfunnels.com/reference/listcommunitiesspacesposts.md): List posts for a space - [Create Post](https://developers.myclickfunnels.com/reference/createcommunitiesspacesposts.md): Create a post in a space. Posts created via the API are auto-approved. The `contact_id` is optional and defaults to the connected user's own contact. - [Fetch Post](https://developers.myclickfunnels.com/reference/getcommunitiesspacesposts.md): Retrieve a post - [Update Post](https://developers.myclickfunnels.com/reference/updatecommunitiesspacesposts.md): Update a post. The `contact_id` field is ignored on update. - [Remove Post](https://developers.myclickfunnels.com/reference/removecommunitiesspacesposts.md): Delete a post - [Approve Post](https://developers.myclickfunnels.com/reference/approvecommunitiesspacespost.md): Approve a post. Sets `approved_at` to the current time, applies any pending draft edit to the live body, and notifies any contacts mentioned in the post body. - [Decline Post](https://developers.myclickfunnels.com/reference/declinecommunitiesspacespost.md): Decline a post. Sets `declined_at` to the current time, marking the post as rejected and hiding it from the community feed. - [Dismiss Reports on Post](https://developers.myclickfunnels.com/reference/dismissreportscommunitiesspacespost.md): Dismiss all pending moderation reports on a post. Clears the report flags and approves the post, making it visible in the community feed. - [Pin Post](https://developers.myclickfunnels.com/reference/pincommunitiesspacespost.md): Pin a post. Sets `is_pinned` to true, causing the post to appear at the top of the community space feed. - [Unpin Post](https://developers.myclickfunnels.com/reference/unpincommunitiesspacespost.md): Unpin a post. Sets `is_pinned` to false, removing the post from the pinned section at the top of the community space feed. - Communities::Spaces::Post::Comment - [List Comments](https://developers.myclickfunnels.com/reference/listcommunitiesspacespostscomments.md): List comments for a post - [Create Comment](https://developers.myclickfunnels.com/reference/createcommunitiesspacespostscomments.md): Create a comment on a post. Comments created via the API are auto-approved. The `contact_id` is optional and defaults to the connected user's own contact. Use `parent_comment_id` for threaded replies. - [Approve Comment](https://developers.myclickfunnels.com/reference/approvecommunitiesspacespostscomment.md): Approve a comment. Sets `approved_at` to the current time and applies any pending draft edit to the live body. - [Decline Comment](https://developers.myclickfunnels.com/reference/declinecommunitiesspacespostscomment.md): Decline a comment. Sets `declined_at` to the current time, marking it as rejected. - [Dismiss Comment Reports](https://developers.myclickfunnels.com/reference/dismissreportscommunitiesspacespostscomment.md): Clear the comment's report flags (reported_at, report_count, report_type) and approve it. - [Fetch Comment](https://developers.myclickfunnels.com/reference/getcommunitiesspacespostscomments.md): Retrieve a comment - [Update Comment](https://developers.myclickfunnels.com/reference/updatecommunitiesspacespostscomments.md): Update a comment. The `contact_id` and `parent_comment_id` fields are ignored on update. - [Remove Comment](https://developers.myclickfunnels.com/reference/removecommunitiesspacespostscomments.md): Delete a comment - Communities::Spaces::Post::Like - [List Post Likes](https://developers.myclickfunnels.com/reference/listcommunitiesspacespostslikes.md): List likes for a post - [Create Post Like](https://developers.myclickfunnels.com/reference/createcommunitiesspacespostslikes.md): Like a post. The `contact_id` is optional and defaults to the connected user's own contact. - [Remove Post Like](https://developers.myclickfunnels.com/reference/removecommunitiesspacespostslikes.md): Unlike a post by deleting the like record - Communities::Spaces::Post::Comment::Like - [List Comment Likes](https://developers.myclickfunnels.com/reference/listcommunitiesspacespostscommentslikes.md): List likes for a comment - [Create Comment Like](https://developers.myclickfunnels.com/reference/createcommunitiesspacespostscommentslikes.md): Like a comment. The `contact_id` is optional and defaults to the connected user's own contact. - [Remove Comment Like](https://developers.myclickfunnels.com/reference/removecommunitiesspacespostscommentslikes.md): Unlike a comment by deleting the like record - Communities::Spaces::Post::VideoEmbed - [List Video Embeds](https://developers.myclickfunnels.com/reference/listcommunitiesspacespostsvideoembeds.md): List video embeds for a post - [Create Video Embed](https://developers.myclickfunnels.com/reference/createcommunitiesspacespostsvideoembeds.md): Attach a video embed to a post. The `url` field is required. - [Fetch Video Embed](https://developers.myclickfunnels.com/reference/getcommunitiesspacespostsvideoembeds.md): Retrieve a video embed - [Remove Video Embed](https://developers.myclickfunnels.com/reference/removecommunitiesspacespostsvideoembeds.md): Delete a video embed from a post - Communities::Membership - [List Memberships](https://developers.myclickfunnels.com/reference/listcommunitiesmemberships.md): List memberships for a community - [Create Membership](https://developers.myclickfunnels.com/reference/createcommunitiesmemberships.md): Add a contact as a member of a community - [Fetch Membership](https://developers.myclickfunnels.com/reference/getcommunitiesmemberships.md): Retrieve a community membership - [Update Membership](https://developers.myclickfunnels.com/reference/updatecommunitiesmemberships.md): Update a community membership (e.g. moderator status or space memberships) - [Remove Membership](https://developers.myclickfunnels.com/reference/removecommunitiesmemberships.md): Remove a contact's membership from a community. This also removes the contact from all Spaces within the community. - Communities::Ban - [List Bans](https://developers.myclickfunnels.com/reference/listcommunitiesbans.md): List bans for a community - [Create Ban](https://developers.myclickfunnels.com/reference/createcommunitiesbans.md): Ban a contact from a community - [Fetch Ban](https://developers.myclickfunnels.com/reference/getcommunitiesbans.md): Retrieve a community ban - [Remove Ban](https://developers.myclickfunnels.com/reference/removecommunitiesbans.md): Unban a contact from a community - Communities::Memberships::BanAction - [Create Membership Ban Action](https://developers.myclickfunnels.com/reference/createcommunitiesmembershipsbanactions.md): Enqueue an async background job to ban one or more community members. The action record is returned immediately with `status: queued`. Poll `GET /communities/memberships/ban_actions/{id}` until… - [Fetch Membership Ban Action](https://developers.myclickfunnels.com/reference/getcommunitiesmembershipsbanactions.md): Retrieve the current status of a membership ban action. Poll this endpoint until `status` is `completed`. - Communities::Memberships::AddToGroupAction - [Create Membership Add-To-Group Action](https://developers.myclickfunnels.com/reference/createcommunitiesmembershipsaddtogroupactions.md): Enqueue an async background job to add one or more community members to one or more spaces (groups). The action record is returned immediately with `status: queued`. Poll `GET… - [Fetch Membership Add-To-Group Action](https://developers.myclickfunnels.com/reference/getcommunitiesmembershipsaddtogroupactions.md): Retrieve the current status of a membership add-to-group action. Poll this endpoint until `status` is `completed`. - Communities::Memberships::RemoveFromGroupAction - [Create Membership Remove-From-Group Action](https://developers.myclickfunnels.com/reference/createcommunitiesmembershipsremovefromgroupactions.md): Enqueue an async background job to remove one or more community members from one or more spaces (groups). The action record is returned immediately with `status: queued`. Poll `GET… - [Fetch Membership Remove-From-Group Action](https://developers.myclickfunnels.com/reference/getcommunitiesmembershipsremovefromgroupactions.md): Retrieve the current status of a membership remove-from-group action. Poll this endpoint until `status` is `completed`. - Communities::Memberships::ExportAction - [List Membership Export Actions](https://developers.myclickfunnels.com/reference/listcommunitiesmembershipsexportactions.md): List previous membership export actions for a community - [Create Membership Export Action](https://developers.myclickfunnels.com/reference/createcommunitiesmembershipsexportactions.md): Enqueue an async background job to export community membership data to a file. The action record is returned immediately with `status: queued`. Poll `GET /communities/memberships/export_actions/{id}`… - [Fetch Membership Export Action](https://developers.myclickfunnels.com/reference/getcommunitiesmembershipsexportactions.md): Retrieve the current status of a membership export action. Poll this endpoint until `status` is `completed`. - Communities::Bans::UnbanAction - [Create Ban Unban Action](https://developers.myclickfunnels.com/reference/createcommunitiesbansunbanactions.md): Enqueue an async background job to unban one or more contacts from a community. The action record is returned immediately with `status: queued`. Poll `GET /communities/bans/unban_actions/{id}` until… - [Fetch Ban Unban Action](https://developers.myclickfunnels.com/reference/getcommunitiesbansunbanactions.md): Retrieve the current status of a ban unban action. Poll this endpoint until `status` is `completed`. - Communities::Bans::ExportAction - [List Ban Export Actions](https://developers.myclickfunnels.com/reference/listcommunitiesbansexportactions.md): List previous ban export actions for a community - [Create Ban Export Action](https://developers.myclickfunnels.com/reference/createcommunitiesbansexportactions.md): Enqueue an async background job to export community ban data to a file. The action record is returned immediately with `status: queued`. Poll `GET /communities/bans/export_actions/{id}` until… - [Fetch Ban Export Action](https://developers.myclickfunnels.com/reference/getcommunitiesbansexportactions.md): Retrieve the current status of a ban export action. Poll this endpoint until `status` is `completed`. - Contact - [List Contacts](https://developers.myclickfunnels.com/reference/listcontacts.md): List contacts for the given workspace. By default, only identified contacts are shown so you won't see anonymous or GDPR-redacted contacts. - [Create Contact](https://developers.myclickfunnels.com/reference/createcontacts.md): Add a new contact to the workspace - [Fetch Contact](https://developers.myclickfunnels.com/reference/getcontacts.md): Retrieve a contact - [Update Contact](https://developers.myclickfunnels.com/reference/updatecontacts.md): Update a contact - [Remove Contact](https://developers.myclickfunnels.com/reference/removecontacts.md): Delete a contact. This is a soft delete: the contact is removed from list endpoints and filters but stays readable by id, with `deleted_at` set. Returns 422 when the contact cannot be deleted - it is… - [Redact Contact](https://developers.myclickfunnels.com/reference/gdpr_destroycontacts.md): This will destroy all personally identifiable information for a contact, including their name and phone number, but does not delete the contact record itself. This cannot be undone. - [Upsert a Contact](https://developers.myclickfunnels.com/reference/upsertcontacts.md): Creates or updates a Contact, matching on the email address. If the Contact does not exist, it will be created. If the Contact does exist, it will be updated. It is not possible to delete a Contact… - Contacts::AppliedTag - [List Applied Tags](https://developers.myclickfunnels.com/reference/listcontactsappliedtags.md): List the applied tags for a contact - [Create Applied Tag](https://developers.myclickfunnels.com/reference/createcontactsappliedtags.md): Assign a tag to a contact by creating an applied tag - [Fetch Applied Tag](https://developers.myclickfunnels.com/reference/getcontactsappliedtags.md): Retrieve an applied tag for a contact - [Remove Applied Tag](https://developers.myclickfunnels.com/reference/removecontactsappliedtags.md): Remove a tag from a contact by deleting an applied tag - Contacts::UnsubscribedTopic - [List Contact Topic Opt-outs](https://developers.myclickfunnels.com/reference/listcontactsunsubscribedtopics.md): List one row per topic the contact has opted out of, including archived topics with existing opt-outs. Subscribed topics are the workspace's active topics minus these rows. The contact's… - [Opt a Contact out of a Topic](https://developers.myclickfunnels.com/reference/createcontactsunsubscribedtopics.md): Opt a contact out of one active topic in their workspace. Records a subscription change attributed to the API caller's membership and emits the contact topic-unsubscribed activity event. Does not… - [List Workspace Contact Topic Opt-outs](https://developers.myclickfunnels.com/reference/listworkspacecontactsunsubscribedtopics.md): List topic opt-outs across the accessible workspace. Filter by id, contact_id or topic_id. - [Fetch Contact Topic Opt-out](https://developers.myclickfunnels.com/reference/getcontactsunsubscribedtopics.md): Read a contact's topic opt-out. - [Resubscribe a Contact to a Topic](https://developers.myclickfunnels.com/reference/removecontactsunsubscribedtopics.md): Resubscribe the contact by removing a topic opt-out. Obtain the contact's renewed consent before calling this endpoint (CAN-SPAM, GDPR, CASL). Records who changed the preference and when. This also… - Contacts::SubscriptionChange - [List Contact Subscription Changes](https://developers.myclickfunnels.com/reference/listcontactssubscriptionchanges.md): Read the contact's subscription-change log, ordered by ID ascending by default. Use sort_order=desc for newest first. Follow Pagination-Next as after, retaining sort_order when overridden. History is… - [Fetch Contact Subscription Change](https://developers.myclickfunnels.com/reference/getcontactssubscriptionchanges.md): Read one immutable subscription-change log entry. Source identifies who made the change, and created_at records when. - Contacts::Event - [List Contact Events](https://developers.myclickfunnels.com/reference/listcontactsevents.md): Read the Event rows used by the contact Activity tab. MessageHub conversation rows are excluded. Numeric and public IDs are accepted. Ordered by created_at then id (ascending by default, desc for… - [Fetch Contact Event](https://developers.myclickfunnels.com/reference/getcontactsevents.md): Read the Event rows used by the contact Activity tab. MessageHub conversation rows are excluded. Numeric and public IDs are accepted. - Contacts::Events::Note - [List Contact Activity Notes](https://developers.myclickfunnels.com/reference/listcontactseventsnotes.md): Read only contact notes from the Activity tab, including API, UI and workflow notes. Ordered by created_at then id with the standard row-id cursor and sort_order. sort_property is not supported. Note… - [Create Contact Activity Note](https://developers.myclickfunnels.com/reference/createcontactseventsnotes.md): Save a note synchronously in the contact's Activity tab with content and optional occurred_at. Attributed to the token's current membership and shown via API in Activity. Missing or blank content and… - [Fetch Contact Activity Note](https://developers.myclickfunnels.com/reference/getcontactseventsnotes.md): Read a contact note. Other event types and inaccessible events return 404. Numeric and public IDs are accepted. - [Update Contact Activity Note](https://developers.myclickfunnels.com/reference/updatecontactseventsnotes.md): Edit content and/or occurred_at while preserving the original author and source, including UI and workflow notes. Blank content and an unparsable occurred_at return 422. Other event types return 404.… - [Delete Contact Activity Note](https://developers.myclickfunnels.com/reference/removecontactseventsnotes.md): Permanently delete a contact note, including UI and workflow notes. Other event types and inaccessible events return 404. No outgoing webhooks are emitted. - Contacts::Filter - [Generate a Contact Filter](https://developers.myclickfunnels.com/reference/generatecontactfilter.md): Translates a natural-language audience description into a ClickFunnels contact filter using an AI model. The response always includes the same key set: a `stable_id` token, a structured `filter`… - [Get a Contact Filter](https://developers.myclickfunnels.com/reference/getcontactfilter.md): Fetches a previously saved contact filter by id. This route is shallow — the workspace is resolved from the filter itself, so no `workspace_id` is required in the path. Use the `id` (or `public_id`)… - Contacts::Tag - [List Tags](https://developers.myclickfunnels.com/reference/listcontactstags.md): List all Contact Tags for your workspace - [Create Tag](https://developers.myclickfunnels.com/reference/createcontactstags.md): Add a new Contact Tag to your Workspace - [Fetch Tag](https://developers.myclickfunnels.com/reference/getcontactstags.md): Retrieve a single Contact Tag - [Update Tag](https://developers.myclickfunnels.com/reference/updatecontactstags.md): Update a Contact Tag - [Remove Tag](https://developers.myclickfunnels.com/reference/removecontactstags.md): Delete a Contact Tag from your workspace - Contacts::TagAction - [List Tag Actions](https://developers.myclickfunnels.com/reference/listcontactstagactions.md): List all Contact Tag Actions for your workspace - [Create Tag Action](https://developers.myclickfunnels.com/reference/createcontactstagactions.md): Bulk-apply or bulk-remove one or more Contact Tags across a filtered set of contacts. The action runs asynchronously — poll the returned record with `GET /api/v2/contacts/tag_actions/{id}` to track… - [Fetch Tag Action](https://developers.myclickfunnels.com/reference/getcontactstagactions.md): Retrieve a single Contact Tag Action and its current async progress - [Remove Tag Action](https://developers.myclickfunnels.com/reference/removecontactstagactions.md): Delete a Contact Tag Action record - Contacts::EnrollAction - [List Enroll Actions](https://developers.myclickfunnels.com/reference/listcontactsenrollactions.md): List all Contact Enroll Actions for your workspace - [Create Enroll Action](https://developers.myclickfunnels.com/reference/createcontactsenrollactions.md): Bulk-enroll a collection of contacts into course sections. Pass `course_ids` to enroll in every section of those courses, or `section_ids` for specific sections (or both). The action runs… - [Fetch Enroll Action](https://developers.myclickfunnels.com/reference/getcontactsenrollactions.md): Retrieve a single Contact Enroll Action and its current async progress - [Remove Enroll Action](https://developers.myclickfunnels.com/reference/removecontactsenrollactions.md): Delete a Contact Enroll Action record - Contacts::RunWorkflowAction - [List Run Workflow Actions](https://developers.myclickfunnels.com/reference/listcontactsrunworkflowactions.md): List all Contact Run Workflow Actions for your workspace - [Create Run Workflow Action](https://developers.myclickfunnels.com/reference/createcontactsrunworkflowactions.md): Run a workflow against a collection of contacts. Requires `workflow_id`. Set `force_run: true` to re-enqueue contacts already in the workflow. The action runs asynchronously — poll the returned… - [Fetch Run Workflow Action](https://developers.myclickfunnels.com/reference/getcontactsrunworkflowactions.md): Retrieve a single Contact Run Workflow Action and its current async progress - [Remove Run Workflow Action](https://developers.myclickfunnels.com/reference/removecontactsrunworkflowactions.md): Delete a Contact Run Workflow Action record - Contacts::UnsubscribeAction - [List Unsubscribe Actions](https://developers.myclickfunnels.com/reference/listcontactsunsubscribeactions.md): List all Contact Unsubscribe Actions for your workspace - [Create Unsubscribe Action](https://developers.myclickfunnels.com/reference/createcontactsunsubscribeactions.md): Bulk-unsubscribe a collection of contacts from email. The action runs asynchronously — poll the returned record with `GET /api/v2/contacts/unsubscribe_actions/{id}` to track progress via… - [Fetch Unsubscribe Action](https://developers.myclickfunnels.com/reference/getcontactsunsubscribeactions.md): Retrieve a single Contact Unsubscribe Action and its current async progress - [Remove Unsubscribe Action](https://developers.myclickfunnels.com/reference/removecontactsunsubscribeactions.md): Delete a Contact Unsubscribe Action record - Contacts::ExportAction - [List Export Actions](https://developers.myclickfunnels.com/reference/listcontactsexportactions.md): List all Contact Export Actions for your workspace - [Create Export Action](https://developers.myclickfunnels.com/reference/createcontactsexportactions.md): Export a collection of contacts to a CSV file. Supply `fields` to specify which contact columns appear in the CSV (including custom attribute keys). The action runs asynchronously — poll the returned… - [Fetch Export Action](https://developers.myclickfunnels.com/reference/getcontactsexportactions.md): Retrieve a single Contact Export Action and its current async progress. When `completed_at` is set, `file_url` contains the CSV download URL. - [Remove Export Action](https://developers.myclickfunnels.com/reference/removecontactsexportactions.md): Delete a Contact Export Action record - Course - [List Courses](https://developers.myclickfunnels.com/reference/listcourses.md): List courses for a team - [Fetch Course](https://developers.myclickfunnels.com/reference/getcourses.md): Retrieve a course - [Create Course](https://developers.myclickfunnels.com/reference/createcourses.md): Create a course for a team. See [Creating a course](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#creating-a-course) in the [Courses… - [Publish Course](https://developers.myclickfunnels.com/reference/publishcourse.md): Makes the course live by setting `published_at`. Pass an optional future `published_at` to schedule the publish; omit it (or leave it blank) to publish immediately. A `published_at` in the past is… - [Update Course](https://developers.myclickfunnels.com/reference/updatecourses.md): Update a course's settings and appearance — including its storefront image (`image_id`), title, and description. Updates are partial: only the attributes you include are changed; omitted attributes… - Courses::Enrollment - [List Enrollments](https://developers.myclickfunnels.com/reference/listcoursesenrollments.md): List enrollments for a course - [Create Enrollment](https://developers.myclickfunnels.com/reference/createcoursesenrollments.md): Add a new enrollment - [Fetch Enrollment](https://developers.myclickfunnels.com/reference/getcoursesenrollments.md): Retrieve an enrollment - [Update Enrollment](https://developers.myclickfunnels.com/reference/updatecoursesenrollments.md): Update an enrollment - Courses::Section - [List Sections](https://developers.myclickfunnels.com/reference/listcoursessections.md): List Sections. Ordered by id ascending by default (pass sort_order=desc for descending), consistent with the pagination cursor, so following the Pagination-Next header returns every section exactly… - [Fetch Section](https://developers.myclickfunnels.com/reference/getcoursessections.md): Fetch Section - [Update Section](https://developers.myclickfunnels.com/reference/updatecoursessections.md): Update Section. See [Permitted section fields (create and update)](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#permitted-section-fields-create-and-update) in the [Courses… - [Create Section](https://developers.myclickfunnels.com/reference/createcoursessections.md): Add a new Section. See [Sections (modules)](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#sections-modules) in the [Courses… - [Publish Section](https://developers.myclickfunnels.com/reference/publishcoursessections.md): Makes a single section live by setting `published_at`, and cascade-publishes its lessons individually so per-lesson side effects fire. The response is the canonical section resource. If section or… - Courses::Lesson - [List Lessons](https://developers.myclickfunnels.com/reference/listcourseslessons.md): List Lessons. Ordered by id ascending by default (pass sort_order=desc for descending), consistent with the pagination cursor, so following the Pagination-Next header returns every lesson exactly… - [Fetch Lesson](https://developers.myclickfunnels.com/reference/getcourseslessons.md): Fetch Lesson - [Update Lesson](https://developers.myclickfunnels.com/reference/updatecourseslessons.md): Update Lesson. See [Permitted lesson fields](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#permitted-lesson-fields) in the [Courses… - [Create Lesson](https://developers.myclickfunnels.com/reference/createcourseslessons.md): Add a new Lesson. The lesson body is authored in Markdown via `lesson_content`, not PML. See [Lessons](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#lessons) in the [Courses… - [Publish Lesson](https://developers.myclickfunnels.com/reference/publishcourseslessons.md): Makes a single lesson live by setting `published_at`. Pass an optional future `published_at` to schedule it; omit it to publish now. A past `published_at` is rejected. A lesson's `published_at` is… - Courses::LessonCompletion - [List Lesson Completions](https://developers.myclickfunnels.com/reference/listcourseslessoncompletions.md): List of enrollment-completion records showing which lessons have been completed by which enrollments. You can filter on one or more `enrollment_id` or `lesson_id` records (see filter params). - [Create Lesson Completion](https://developers.myclickfunnels.com/reference/createcourseslessoncompletions.md): 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. - [Fetch Lesson Completion](https://developers.myclickfunnels.com/reference/getcourseslessoncompletions.md): Retrieve a enrollment-lesson completion record - [Remove Lesson Completion](https://developers.myclickfunnels.com/reference/removecourseslessoncompletions.md): Unmark a lesson as completed. This action deletes the record. - Courses::Sections::PublishAction - [List Publish Actions](https://developers.myclickfunnels.com/reference/listcoursessectionspublishactions.md): List course-section publish actions for a course - [Create Publish Action](https://developers.myclickfunnels.com/reference/createcoursessectionspublishactions.md): Publish one or more course sections AND the lessons they contain. Provide exactly one of `target_ids` (a nonempty array of course-section public IDs) or `target_all: true` to publish every… - [Fetch Publish Action](https://developers.myclickfunnels.com/reference/getcoursessectionspublishactions.md): Retrieve a single course-section publish action and its current async progress - [Remove Publish Action](https://developers.myclickfunnels.com/reference/removecoursessectionspublishactions.md): Delete a course-section publish action record - Discount - [List Discounts](https://developers.myclickfunnels.com/reference/listdiscounts.md): List the discounts in a workspace. - [Create Discount](https://developers.myclickfunnels.com/reference/creatediscounts.md): Create a discount in a workspace. A `code`-type discount (the default) needs a unique `code`; a `percentage` discount needs `percent`; a `fixed` discount needs a positive `amount`. Creating a… - [Fetch Discount](https://developers.myclickfunnels.com/reference/getdiscounts.md): Retrieve a single discount. - [Update Discount](https://developers.myclickfunnels.com/reference/updatediscounts.md): Update a discount. Money-affecting fields are locked once the discount has been redeemed and return 422, while renaming and expiring still work. A discount that is already expired freezes its other… - [Remove Discount](https://developers.myclickfunnels.com/reference/removediscounts.md): Hard-delete a discount. Only a discount that has NOT been applied to an order can be deleted; a used discount returns 422 (expire it with `expired: true` instead, to preserve its order history). A… - Domain - [List Domains](https://developers.myclickfunnels.com/reference/listdomains.md): List all domains for a workspace. Use this endpoint to retrieve domain IDs for use with other resources such as Funnels. These are **website hosting** domains (ownership + hosting CNAME + SSL). To… - [Fetch Domain](https://developers.myclickfunnels.com/reference/getdomain.md): Fetch a single domain by ID. - Download - [List Downloads](https://developers.myclickfunnels.com/reference/listdownloads.md): List downloads for a workspace. Use each download's `asset_id` when configuring a product variant's digital-asset access. - [Fetch Download](https://developers.myclickfunnels.com/reference/getdownloads.md): Fetch a single download by ID, including the Asset ID used to configure product-variant access. - Emails::Address - [List Email Addresses](https://developers.myclickfunnels.com/reference/listemailsaddresses.md): List all email addresses for a workspace. See [Addresses (pick a usable sender)](https://accounts.myclickfunnels.com/.well-known/emails/skill.md#addresses-pick-a-usable-sender) in the [Emails… - [Create Email Address](https://developers.myclickfunnels.com/reference/createemailsaddresses.md): Create a sender ("from") email address. Provide `username` and `name` (the from-name shown on emails). By default, the address is created on ClickFunnels' shared sending domain. To use a custom… - [Get Email Address](https://developers.myclickfunnels.com/reference/getemailsaddresses.md): Retrieve a single email address - [Update Email Address](https://developers.myclickfunnels.com/reference/updateemailsaddresses.md): Update a sender address — most commonly to change its `name` (the from-name). You may also move it to a different ready-for-sending custom domain via `emails_domain_id`. - [Archive Email Address](https://developers.myclickfunnels.com/reference/removeemailsaddresses.md): Archive (soft-delete) a sender address. Once archived the sender is treated as gone: it is excluded from the list endpoint and a subsequent GET/PATCH/DELETE on its id returns 404 (there is no… - Emails::Broadcast - [List Email Broadcasts](https://developers.myclickfunnels.com/reference/listemailsbroadcasts.md): List all email broadcasts for a workspace. Filterable by id and status. - [Create Email Broadcast](https://developers.myclickfunnels.com/reference/createemailsbroadcast.md): Create a new email broadcast. Broadcasts are created in DRAFT status — creating one does not send it. The top-level subject/preheadline are split-test variant A; pass one alternate in variants and… - [Fetch Email Broadcast](https://developers.myclickfunnels.com/reference/getemailsbroadcast.md): Retrieve a single email broadcast by ID - [Update Email Broadcast](https://developers.myclickfunnels.com/reference/updateemailsbroadcast.md): Update an email broadcast. Only broadcasts in draft status can be updated. The top-level subject/preheadline are variant A; omit variants to preserve B, send one entry to replace B, or send an empty… - [Delete Email Broadcast](https://developers.myclickfunnels.com/reference/removeemailsbroadcast.md): Delete an email broadcast. Only broadcasts in draft status can be deleted. - [Fetch Email Broadcast Stats](https://developers.myclickfunnels.com/reference/getemailsbroadcaststats.md): Delivery progress, engagement and revenue for one email broadcast, the same numbers as the broadcast's page in the ClickFunnels dashboard. The numbers cover the broadcast's send window, returned as… - [Create Resend-to-Unopened Draft](https://developers.myclickfunnels.com/reference/resendunopenedemailsbroadcast.md): Create an independent editable draft from a broadcast that has been complete for at least 24 hours, including the exact 24-hour boundary. Copies published content, sender and reply-to settings,… - [Send Test Email Broadcast](https://developers.myclickfunnels.com/reference/sendtestemailsbroadcast.md): Send the saved main broadcast content to 1-5 explicit recipients without changing the broadcast or sending its audience. Matching workspace contacts personalize the preview. Subject and sender… - [Fetch Email Broadcast Sent Content](https://developers.myclickfunnels.com/reference/getemailsbroadcastsentcontent.md): The HTML an email broadcast actually sent, one entry per distinct document. A broadcast points at its template rather than copying it, so the template's body (`GET… - Emails::Broadcasts::SendAction - [List Send Actions](https://developers.myclickfunnels.com/reference/listemailsbroadcastssendactions.md): List all send actions for an email broadcast. Send actions represent past or scheduled delivery attempts for the broadcast. - [Create Send Action](https://developers.myclickfunnels.com/reference/createemailsbroadcastssendactions.md): Send (or schedule) an email broadcast by creating a Send Action. This is the same trigger the ClickFunnels dashboard fires when you click "Send". The request body is optional — a bodyless POST… - [Fetch Send Action](https://developers.myclickfunnels.com/reference/getemailsbroadcastssendactions.md): Retrieve a single send action and its current async delivery progress. Compare `performed_count` to `target_count` to determine how far along delivery is. `completed_at` is set when delivery finishes. - [Remove Send Action](https://developers.myclickfunnels.com/reference/removeemailsbroadcastssendactions.md): Cancel a broadcast's scheduled send. The broadcast returns to `draft` and all of its send actions are removed (a broadcast sent in each contact's time zone or as a split test has several), so it can… - Emails::Domain - [List Email Domains](https://developers.myclickfunnels.com/reference/listemailsdomains.md): List all email sending domains (DKIM/SPF/DMARC) for a workspace. These are **email sending** domains - for website/hosting domains, see **listDomains**. Each result separates workspace ownership… - [Create Email Domain](https://developers.myclickfunnels.com/reference/createemailsdomains.md): Provision a sending domain for a workspace. Find-or-create: returns `200` with the existing record if a domain with this name already exists for the workspace, or `201` with freshly generated DNS… - [Get Email Domain](https://developers.myclickfunnels.com/reference/getemailsdomains.md): Retrieve a single email sending domain (DKIM/SPF/DMARC), including its ownership, transport, readiness, and return-path flags plus the DNS records to add at the provider. These are **email sending**… - [Verify Email Domain](https://developers.myclickfunnels.com/reference/verifyemailsdomains.md): Re-run the DNS checks for DKIM, SPF, DMARC, and the return path, cached for about 10 minutes, and return the refreshed status together with the current ownership state. A `200` means the check ran,… - Emails::Settings - [Get Email Settings](https://developers.myclickfunnels.com/reference/getemailssettings.md): Retrieve email settings for a workspace. A workspace that has never configured its email settings has no persisted record yet; this returns `200` with the empty settings shape (`address: null`,… - [Update Email Settings](https://developers.myclickfunnels.com/reference/updateemailssettings.md): Update a workspace's email/marketing settings. Most importantly, this sets the marketing (business) address, which is the workspace-wide prerequisite for creating broadcasts and workflow send-email… - Emails::Template - [List Email Templates](https://developers.myclickfunnels.com/reference/listemailstemplates.md): List all email templates for a workspace - [Fetch Email Template](https://developers.myclickfunnels.com/reference/getemailstemplate.md): Retrieve a single email template - [Create Email Template](https://developers.myclickfunnels.com/reference/createemailstemplate.md): 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). See [Create a… - [Update Email Template](https://developers.myclickfunnels.com/reference/updateemailstemplate.md): Update an email template. Only the provided fields are changed. Invalid Liquid in html_body is rejected with 422. See [Update a… - [Delete Email Template](https://developers.myclickfunnels.com/reference/deleteemailstemplate.md): Delete an email template. Returns 422 if the template is shared or is in use by a workflow send-email step. See [Delete a… - Emails::Topic - [List Email Topics](https://developers.myclickfunnels.com/reference/listemailstopics.md): List all email topics for a workspace. Use include_archived=true to include archived topics. - [Create Email Topic](https://developers.myclickfunnels.com/reference/createemailstopic.md): Create a new email topic for a workspace - [Fetch Email Topic](https://developers.myclickfunnels.com/reference/getemailstopic.md): Retrieve a single email topic - [Update Email Topic](https://developers.myclickfunnels.com/reference/updateemailstopic.md): Update an email topic - [Archive Email Topic](https://developers.myclickfunnels.com/reference/archiveemailstopic.md): Archive an email topic. System topics cannot be archived. - Form - [List Forms](https://developers.myclickfunnels.com/reference/listforms.md): List forms for a workspace - [Create Form](https://developers.myclickfunnels.com/reference/createforms.md): Add a new form - [Fetch Form](https://developers.myclickfunnels.com/reference/getforms.md): Retrieve a form. A survey's questions are stored in its Form; read surveys and their responses through the SurveyWorkflow resources. See the [Forms and surveys… - [Update Form](https://developers.myclickfunnels.com/reference/updateforms.md): Update a form - [Remove Form](https://developers.myclickfunnels.com/reference/removeforms.md): Delete a form - Forms::FieldSet - [List Field Sets](https://developers.myclickfunnels.com/reference/listformsfieldsets.md): List field sets for a form - [Create Field Set](https://developers.myclickfunnels.com/reference/createformsfieldsets.md): Add a new field set - [Fetch Field Set](https://developers.myclickfunnels.com/reference/getformsfieldsets.md): Retrieve a field set - [Update Field Set](https://developers.myclickfunnels.com/reference/updateformsfieldsets.md): Update a field set - [Remove Field Set](https://developers.myclickfunnels.com/reference/removeformsfieldsets.md): Delete a field set - Forms::Field - [List Fields](https://developers.myclickfunnels.com/reference/listformsfields.md): List fields for a field set - [Create Field](https://developers.myclickfunnels.com/reference/createformsfields.md): Add a new field - [Fetch Field](https://developers.myclickfunnels.com/reference/getformsfields.md): Retrieve a field - [Update Field](https://developers.myclickfunnels.com/reference/updateformsfields.md): Update a field - [Remove Field](https://developers.myclickfunnels.com/reference/removeformsfields.md): Delete a field - [Reorder Fields](https://developers.myclickfunnels.com/reference/reorderformsfields.md): Reorders the fields of a field set. - Forms::Fields::Option - [List Options](https://developers.myclickfunnels.com/reference/listformsfieldsoptions.md): List options for a field - [Create Option](https://developers.myclickfunnels.com/reference/createformsfieldsoptions.md): Add a new option to a field - [Fetch Option](https://developers.myclickfunnels.com/reference/getformsfieldsoptions.md): Retrieve a option for a field - [Update Option](https://developers.myclickfunnels.com/reference/updateformsfieldsoptions.md): Update a option for a field - [Remove Option](https://developers.myclickfunnels.com/reference/removeformsfieldsoptions.md): Delete a option for a field - Forms::Submission - [List Submissions](https://developers.myclickfunnels.com/reference/listformssubmissions.md): List submissions for a form - [Create Submission](https://developers.myclickfunnels.com/reference/createformssubmissions.md): Add a new submission to a form - [Fetch Submission](https://developers.myclickfunnels.com/reference/getformssubmissions.md): Retrieve a submission for a form - [Update Submission](https://developers.myclickfunnels.com/reference/updateformssubmissions.md): Update a submission for a form - [Remove Submission](https://developers.myclickfunnels.com/reference/removeformssubmissions.md): Delete a submission for a form - Forms::Submissions::Answer - [List Answers](https://developers.myclickfunnels.com/reference/listformssubmissionsanswers.md): List answers for a submission - [Create Answer](https://developers.myclickfunnels.com/reference/createformssubmissionsanswers.md): Add a new answer to a submission - [Fetch Answer](https://developers.myclickfunnels.com/reference/getformssubmissionsanswers.md): Retrieve a answer for a submission - [Update Answer](https://developers.myclickfunnels.com/reference/updateformssubmissionsanswers.md): Update a answer for a submission - [Remove Answer](https://developers.myclickfunnels.com/reference/removeformssubmissionsanswers.md): Delete a answer for a submission - FormSubmission - [List Form Submissions](https://developers.myclickfunnels.com/reference/listformsubmissions.md): List form submissions. This is a list of all form submissions for the workspace, including the submitted standard and custom fields. Please refer to the `Form` and `Forms::Submission` resources if… - [Fetch Form Submission](https://developers.myclickfunnels.com/reference/getformsubmissions.md): Retrieve a form submission. This is a record of a form submission, including the submitted standard and custom fields. Please refer to the `Form` and `Forms::Submission` resources if you would like… - Funnel - [List Funnels](https://developers.myclickfunnels.com/reference/listfunnels.md): List Funnels - [Create Funnel](https://developers.myclickfunnels.com/reference/createfunnel.md): Create a new funnel in the workspace. Creating a funnel automatically creates a workflow. You can then add pages to the funnel by creating pages with `funnel.funnel_id` set to the new funnel's ID… - [Fetch Funnel](https://developers.myclickfunnels.com/reference/getfunnels.md): Fetch a funnel by numeric id or public id. The unwrapped response's `live_mode` controls test versus live payment processing, not page visibility or publication status. Use `GET /api/v2/pages/:id` to… - [Update Funnel](https://developers.myclickfunnels.com/reference/updatefunnels.md): Update a funnel's settings, including its path, favicon, domain, and tags, by numeric id or public id with the `funnel` JSON root. PATCH is also supported. The favicon is writable only on this… - [Fetch Funnel Structure](https://developers.myclickfunnels.com/reference/getfunnelstructure.md): A funnel's steps as a single, flat, ordered list — the same top‑to‑bottom flow you see in the funnel builder. Use it to read or visualize how a funnel is laid out. Each entry in `steps` is one of… - [Fetch Funnel Stats](https://developers.myclickfunnels.com/reference/getfunnelstats.md): Retrieve detailed statistics for a funnel, including a summary of key metrics and optional per-step breakdowns of views, opt-ins, sales, and earnings. Defaults to a 30-day timerange ending now.… - [Delete an empty Funnel](https://developers.myclickfunnels.com/reference/destroyfunnels.md): Permanently remove an active or archived, unshared funnel only when its workflow has no steps beyond its generated root. Populated funnels must be archived instead. The workflow and its root step are… - [Archive a Funnel](https://developers.myclickfunnels.com/reference/archivefunnels.md): Synchronously archive the funnel and its attached show-page pages. Its URL path is disambiguated, and redirect steps targeting it are unlinked. Restoring the funnel does not restore the original path… - [Restore an archived Funnel](https://developers.myclickfunnels.com/reference/unarchivefunnels.md): Synchronously restore the funnel and its attached show-page pages. The disambiguated URL path remains. For funnels with show-page steps, associated archived products are submitted for background… - Funnels::CloneAction - [List Funnel Clone Actions](https://developers.myclickfunnels.com/reference/listfunnelscloneactions.md): List retained API clone receipts for a source funnel, including queued, processing, completed, and failed attempts. This does not include transient UI actions or start any new work. - [Duplicate Funnel Asynchronously](https://developers.myclickfunnels.com/reference/createfunnelscloneactions.md): Create a durable asynchronous receipt for a new same-workspace copy of the source funnel. Send no request body. Every accepted request creates a distinct copy; polling or retry delivery of the same… - [Fetch Funnel Clone Action](https://developers.myclickfunnels.com/reference/getfunnelscloneactions.md): Retrieve a durable funnel clone receipt by integer or public ID. Polling reads state only and never restarts the duplication. - Funnels::ConditionalSplitStep - [List Conditional Split Steps](https://developers.myclickfunnels.com/reference/listfunnelconditionalsplitsteps.md): List all conditional split steps in a funnel. Each entry exposes its `condition` (filter_id + is_setup) and 2-entry `branches` array (`[matched, unmatched]`). Pass `expand[]=filter` to include the… - [Create Conditional Split Step](https://developers.myclickfunnels.com/reference/createfunnelconditionalsplitstep.md): Add a new conditional split step to a funnel. All fields are optional — providing none creates an empty unconfigured split. Provide `condition` to set the contact filter, `branches` to attach pages… - [Fetch Conditional Split Step](https://developers.myclickfunnels.com/reference/getfunnelconditionalsplitstep.md): Fetch a single conditional split step with its branches and condition. - [Update Conditional Split Step](https://developers.myclickfunnels.com/reference/updatefunnelconditionalsplitstep.md): Update the `condition` and/or attach pages to existing `branches`. At least one of the two must be provided. - `condition.filter_id` is the public id of a RefineFilter in the same workspace. -… - [Destroy Conditional Split Step](https://developers.myclickfunnels.com/reference/destroyfunnelconditionalsplitstep.md): Remove a conditional split from the funnel. **A 1-branch conditional split is not a supported state**, so any value of `branch` collapses the entire split: - `DELETE… - Funnels::SplitTestStep - [List Split Test Steps](https://developers.myclickfunnels.com/reference/listfunnelsplitteststeps.md): List all split test steps in a funnel. Each split test wraps an existing page in a two-branch split and optionally attaches a second page. See the [Funnels… - [Create Split Test Step](https://developers.myclickfunnels.com/reference/createfunnelsplitteststep.md): Wrap an existing page in a new split test. Provide one variant to wrap a single page (the second branch starts empty and can be attached later via PATCH), or two variants to wrap a page and attach a… - [Fetch Split Test Step](https://developers.myclickfunnels.com/reference/getfunnelsplitteststep.md): Fetch a single split test step with its variants and weights. - [Update Split Test Step](https://developers.myclickfunnels.com/reference/updatefunnelsplitteststep.md): Update a split test's variants: attach a page to an empty branch, swap an existing variant's page, or adjust the weights. The `variants` array length must equal the number of branches in the split… - [Destroy Split Test Step](https://developers.myclickfunnels.com/reference/destroyfunnelsplitteststep.md): Remove a split test from the funnel. **A 1-branch split test is not a supported state**, so any value of `branch` collapses the entire split: - `DELETE /funnels/{funnel_id}/split_test_steps/{id}`… - Funnels::Tag - [List Tags](https://developers.myclickfunnels.com/reference/listfunnelstags.md): List Tags - [Create Tag](https://developers.myclickfunnels.com/reference/createfunnelstags.md): Create Tag - [Fetch Tag](https://developers.myclickfunnels.com/reference/getfunnelstags.md): Fetch Tag - [Update Tag](https://developers.myclickfunnels.com/reference/updatefunnelstags.md): Update Tag - [Remove Tag](https://developers.myclickfunnels.com/reference/removefunnelstags.md): Remove Tag - Image - [List Images](https://developers.myclickfunnels.com/reference/listimages.md): List Images - [Create Image](https://developers.myclickfunnels.com/reference/createimages.md): Create Image - [Fetch Image](https://developers.myclickfunnels.com/reference/getimages.md): Fetch Image - [Update Image](https://developers.myclickfunnels.com/reference/updateimages.md): Update Image - [Remove Image](https://developers.myclickfunnels.com/reference/removeimages.md): Remove Image - Fulfillment - [List Fulfillments](https://developers.myclickfunnels.com/reference/listfulfillments.md): List all fulfillments for your workspace. You will find detailed information about fulfilling orders is in [our Fulfillments guide](https://developers.myclickfunnels.com/docs/fulfillments). - [Create Fulfillment](https://developers.myclickfunnels.com/reference/createfulfillments.md): Fulfill an order or a part of an order. More information in [our Fulfillments guide](https://developers.myclickfunnels.com/docs/fulfillments). - [Fetch Fulfillment](https://developers.myclickfunnels.com/reference/getfulfillments.md): Retrieve a specific fulfillment in the current workspace - [Update Fulfillment](https://developers.myclickfunnels.com/reference/updatefulfillments.md): Update a specific fulfillment. - [Remove Fulfillment](https://developers.myclickfunnels.com/reference/removefulfillments.md): Remove Fulfillment - [Cancel a Fulfillment](https://developers.myclickfunnels.com/reference/cancelfulfillments.md): This will cancel a Fulfillment. A Fulfillment can only be cancelled when it's in a "fulfilled" state. The "cancelled" state is final. - Fulfillments::Location - [List Locations](https://developers.myclickfunnels.com/reference/listfulfillmentslocations.md): List Locations - [Create Location](https://developers.myclickfunnels.com/reference/createfulfillmentslocations.md): Create Location - [Fetch Location](https://developers.myclickfunnels.com/reference/getfulfillmentslocations.md): Fetch Location - [Update Location](https://developers.myclickfunnels.com/reference/updatefulfillmentslocations.md): Update Location - [Remove Location](https://developers.myclickfunnels.com/reference/removefulfillmentslocations.md): Remove Location - Order - [List Orders](https://developers.myclickfunnels.com/reference/listorders.md): List all orders for the current workspace. Please refer to [our Orders Overview guide](https://developers.myclickfunnels.com/docs/orders) for more information about the different types of orders and… - [Create External Order](https://developers.myclickfunnels.com/reference/createorders.md): Create a new [external order](https://developers.myclickfunnels.com/docs/orders#external-orders) in the current workspace. This is useful if you process payments outside of ClickFunnels, but still… - [Fetch Order](https://developers.myclickfunnels.com/reference/getorders.md): Retrieve a specific order in the current workspace. Please refer to [our Orders Overview guide](https://developers.myclickfunnels.com/docs/orders) for more information about the different types of… - [Update Order](https://developers.myclickfunnels.com/reference/updateorders.md): Update a specific order in the current workspace. [External orders](https://developers.myclickfunnels.com/docs/orders#external-orders) have different updateable fields than orders that have a regular… - [Cancel Order](https://developers.myclickfunnels.com/reference/cancelorder.md): Cancel a subscription order through ClickFunnels' own cancel path (the same path the in-app "Cancel subscription" flow uses) so the cancelation actually propagates to the payment processor (Payments… - Orders::AppliedTag - [List Applied Tags](https://developers.myclickfunnels.com/reference/listordersappliedtags.md): List the applied tags for an order - [Create Applied Tag](https://developers.myclickfunnels.com/reference/createordersappliedtags.md): Assign a tag to an order by creating an applied tag - [Fetch Applied Tag](https://developers.myclickfunnels.com/reference/getordersappliedtags.md): Retrieve an applied tag for an order - [Remove Applied Tag](https://developers.myclickfunnels.com/reference/removeordersappliedtags.md): Remove a tag from an order by deleting an applied tag - Orders::Invoice - [List Invoices](https://developers.myclickfunnels.com/reference/listordersinvoices.md): List invoices for a specific order. Please refer to [our Orders Overview guide](https://developers.myclickfunnels.com/docs/orders/invoices) for more information about the different types of invoices… - [Create External Invoice](https://developers.myclickfunnels.com/reference/createordersinvoices.md): Create an invoice for an external order. This is useful if you process payments outside of ClickFunnels, but still want to make use of ClickFunnels' automations and funnels. Refer to the… - [Fetch Invoice](https://developers.myclickfunnels.com/reference/getordersinvoices.md): Retrieve an invoice for an order. Please refer to [our Orders Overview guide](https://developers.myclickfunnels.com/docs/orders/invoices) for more information about the different types of invoices… - [Update External Invoice](https://developers.myclickfunnels.com/reference/updateordersinvoices.md): Update a specific invoice in the current workspace. Currently, only invoices of [external orders](https://developers.myclickfunnels.com/docs/orders#external-orders) can be updated. So, you can't… - [List Workspace Invoices](https://developers.myclickfunnels.com/reference/listworkspaceordersinvoices.md): List all invoices for a specific workspace. Please refer to the [API documentation](https://developers.myclickfunnels.com/docs/orders/invoices) for more information about the different types of… - [Abandon Invoice](https://developers.myclickfunnels.com/reference/abandonordersinvoices.md): Abandon an unpaid, draft, or past-due invoice through ClickFunnels' own abandon path (the same path the in-app "Abandon invoice" button uses) so the abandon propagates to the payment processor and… - Orders::Invoices::Restock - [List Restocks](https://developers.myclickfunnels.com/reference/listrestocks.md): List Restocks - [Fetch Restock](https://developers.myclickfunnels.com/reference/getrestock.md): Fetch Restock - Orders::LineItems::Change - [Preview Variant/Price Change](https://developers.myclickfunnels.com/reference/previeworderslineitemschange.md): Returns a non-destructive preview of changing the variant and price of a subscription line item, including proration math, the next charge amount, and the effective date. Follows the same… - [Change Variant/Price](https://developers.myclickfunnels.com/reference/performorderslineitemschange.md): Commits a variant/price change for a subscription line item. The change must be configured as an allowed upgrade or downgrade option on the source variant. By default, upgrades take effect… - Orders::Transaction - [List Transactions](https://developers.myclickfunnels.com/reference/listorderstransactions.md): List transactions for an order - [Fetch Transaction](https://developers.myclickfunnels.com/reference/getorderstransactions.md): Retrieve a transaction for an order - [Refund Transaction](https://developers.myclickfunnels.com/reference/refundorderstransactions.md): Refund this charge, in full, through ClickFunnels' own refund path (the same path the in-app refund button uses) so the money actually moves back through the payment processor (Payments AI/Rebilly or… - Orders::Tag - [List Tags](https://developers.myclickfunnels.com/reference/listorderstags.md): List all order tags for your workspace - [Create Tag](https://developers.myclickfunnels.com/reference/createorderstags.md): Add a new order tag to your workspace - [Fetch Tag](https://developers.myclickfunnels.com/reference/getorderstags.md): Retrieve a single order tag - [Update Tag](https://developers.myclickfunnels.com/reference/updateorderstags.md): Update an order tag - [Remove Tag](https://developers.myclickfunnels.com/reference/removeorderstags.md): Delete an order tag from your workspace - Page - [List Pages](https://developers.myclickfunnels.com/reference/listpages.md): Page offers extra information about ClickFunnels pages, like those that are part of funnels. - [Create Page](https://developers.myclickfunnels.com/reference/createpage.md): Create a new internal page in the workspace. By default, creating a page without references to a funnel or show page step will create a standalone landing page. You can optionally attach the page to… - [Create External Page](https://developers.myclickfunnels.com/reference/createexternalpage.md): Create an externally-hosted (SDK) page. Unlike internal pages, the visual content lives on your own domain and is registered with ClickFunnels via a lightweight SDK integration. **Required fields:**… - [Fetch Page](https://developers.myclickfunnels.com/reference/getpages.md): Fetch a page by numeric id or public id. The unwrapped response includes its computed `url`, which is not a publish status or proof of public reachability. After an intentional content update, fetch… - [Update Page](https://developers.myclickfunnels.com/reference/updatepages.md): Update an existing internal, custom HTML, or external (SDK) page. This existing write saves supported page content live; there is currently no separate public page publish or status operation. Read… - [Delete Page](https://developers.myclickfunnels.com/reference/deletepage.md): Delete a page by ID. Works for both internal and external (SDK) pages. The page's show page steps are destroyed first (removing the funnel step slot entirely), then the page itself (including its… - [Remove Products from Page](https://developers.myclickfunnels.com/reference/removeproductsfrompage.md): Detach one or more products from the page's show page step. This is the **only** way to remove products from a page via the API — the `show_page_step.product_ids` and `show_page_step.bumps` fields on… - [Fetch Page Stats](https://developers.myclickfunnels.com/reference/getpagestats.md): Retrieve statistics for a page, including views, opt-ins, sales, and earnings. Stats are computed from the page's associated funnel step. `funnel` and `step` are `null` when the page is not part of… - [Create Custom HTML Page](https://developers.myclickfunnels.com/reference/createcustomhtmlpage.md): Create a ClickFunnels-hosted custom HTML page: you supply the complete HTML document and ClickFunnels serves it verbatim at a path on the funnel's domain — no page editor, no PML. Ideal for… - [Fetch Custom HTML Page Body](https://developers.myclickfunnels.com/reference/getpagecustomhtml.md): Return the stored HTML body of a ClickFunnels-hosted custom HTML page. The body is kept off the standard page payload because it can be large — fetch it only when you need the source (e.g. to modify… - Product - [List Products](https://developers.myclickfunnels.com/reference/listproducts.md): List all products for a workspace - [Create Product](https://developers.myclickfunnels.com/reference/createproducts.md): Add a new product to a workspace - [Fetch Product](https://developers.myclickfunnels.com/reference/getproducts.md): Retrieve a product for a workspace - [Update Product](https://developers.myclickfunnels.com/reference/updateproducts.md): Update a product for a workspace - [Archive a Product](https://developers.myclickfunnels.com/reference/archiveproducts.md): This will archive a Product. A product can only be archived if it's not in the "live" state. - [Unarchive a Product](https://developers.myclickfunnels.com/reference/unarchiveproducts.md): This will unarchive a Product. - Products::Collection - [List Collections](https://developers.myclickfunnels.com/reference/listproductscollections.md): List Collections - [Create Collection](https://developers.myclickfunnels.com/reference/createproductscollections.md): Create Collection - [Fetch Collection](https://developers.myclickfunnels.com/reference/getproductscollections.md): Fetch Collection - [Update Collection](https://developers.myclickfunnels.com/reference/updateproductscollections.md): Update Collection - Products::Price - [List Prices](https://developers.myclickfunnels.com/reference/listproductsprices.md): List all prices for a given product. This will include all prices for all variants of the product. You can also filter by variant_id to get prices for a specific variant. - [Fetch Price](https://developers.myclickfunnels.com/reference/getproductsprices.md): Retrieve a single price - [Update Price](https://developers.myclickfunnels.com/reference/updateproductsprices.md): Update a single price - [Create Price](https://developers.myclickfunnels.com/reference/createproductsprices.md): Create a new price for a given variant. Note that you must set a `variant_id` in the path. - Products::Prices::ChangeOption - [List Upgrade/Downgrade Options](https://developers.myclickfunnels.com/reference/listproductspriceschangeoptions.md): Returns the allowed upgrade and downgrade target variants for a price, grouped by target variant. Each group lists the prices on the target variant that a subscription using this source price may… - Products::Variant - [List Variants](https://developers.myclickfunnels.com/reference/listproductsvariants.md): List variants for a product - [Create Variant](https://developers.myclickfunnels.com/reference/createproductsvariants.md): Create a new variant for a product - [Fetch Variant](https://developers.myclickfunnels.com/reference/getproductsvariants.md): Retrieve a single variant - [Update Variant](https://developers.myclickfunnels.com/reference/updateproductsvariants.md): Update a single variant - Products::Tag - [List Tags](https://developers.myclickfunnels.com/reference/listproductstags.md): List tags for a product - [Create Tag](https://developers.myclickfunnels.com/reference/createproductstags.md): Add a new tag to a product - [Fetch Tag](https://developers.myclickfunnels.com/reference/getproductstags.md): Retrieve a tag for a product - [Update Tag](https://developers.myclickfunnels.com/reference/updateproductstags.md): Update a tag for a product - [Remove Tag](https://developers.myclickfunnels.com/reference/removeproductstags.md): Delete a tag for a product - RefineFilter - [List Refine Filters](https://developers.myclickfunnels.com/reference/listworkspacerefinefilters.md): List saved filters in a workspace, ordered by id ascending. `after` and `per_page` are the switch between two modes. For backwards compatibility, omitting both returns the complete registry in one… - [Create Refine Filter](https://developers.myclickfunnels.com/reference/createworkspacerefinefilter.md): Create a new contact RefineFilter in the workspace. This endpoint does not create order filters. The `criteria` array must contain at least one entry. Criteria are validated against the… - [Fetch Refine Filter](https://developers.myclickfunnels.com/reference/getrefinefilter.md): Fetch a single saved filter by its public id. Inspect `filter_class` before applying it to contacts or orders. Treat order filters as read-only here and edit them in the ClickFunnels Orders UI;… - [Update Refine Filter](https://developers.myclickfunnels.com/reference/updaterefinefilter.md): Update an existing RefineFilter. All fields are optional — only provided fields are updated. When `criteria` is supplied it replaces the entire criteria set (must contain at least one entry). 422… - [Destroy Refine Filter](https://developers.myclickfunnels.com/reference/destroyrefinefilter.md): Delete a RefineFilter. Note that deleting a filter that is currently attached to a conditional split step or other surface will leave those surfaces without a filter (`condition.filter_id` will… - Sales::Pipeline - [List Pipelines](https://developers.myclickfunnels.com/reference/listsalespipelines.md): List Pipelines - [Create Pipeline](https://developers.myclickfunnels.com/reference/createsalespipelines.md): Create Pipeline - [Fetch Pipeline](https://developers.myclickfunnels.com/reference/getsalespipelines.md): Fetch Pipeline - [Update Pipeline](https://developers.myclickfunnels.com/reference/updatesalespipelines.md): Update Pipeline - [Remove Pipeline](https://developers.myclickfunnels.com/reference/removesalespipelines.md): Delete a pipeline and its stages. The pipeline must be empty: if any opportunities remain in its stages the request is rejected with 422, so delete those opportunities or move them to another… - Sales::Pipelines::Stage - [List Stages](https://developers.myclickfunnels.com/reference/listsalespipelinesstages.md): List Stages - [Create Stage](https://developers.myclickfunnels.com/reference/createsalespipelinesstages.md): Create Stage - [Fetch Stage](https://developers.myclickfunnels.com/reference/getsalespipelinesstages.md): Fetch Stage - [Update Stage](https://developers.myclickfunnels.com/reference/updatesalespipelinesstages.md): Update Stage - [Remove Stage](https://developers.myclickfunnels.com/reference/removesalespipelinesstages.md): Remove Stage - Sales::Opportunity - [List Opportunities](https://developers.myclickfunnels.com/reference/listsalesopportunities.md): List Opportunities - [Create Opportunity](https://developers.myclickfunnels.com/reference/createsalesopportunities.md): Create Opportunity - [Fetch Opportunity](https://developers.myclickfunnels.com/reference/getsalesopportunities.md): Fetch Opportunity - [Update Opportunity](https://developers.myclickfunnels.com/reference/updatesalesopportunities.md): Update Opportunity - [Remove Opportunity](https://developers.myclickfunnels.com/reference/removesalesopportunities.md): Remove Opportunity - Sales::Opportunities::Note - [List Notes](https://developers.myclickfunnels.com/reference/listsalesopportunitiesnotes.md): List Notes - [Create Note](https://developers.myclickfunnels.com/reference/createsalesopportunitiesnotes.md): Create Note - [Fetch Note](https://developers.myclickfunnels.com/reference/getsalesopportunitiesnotes.md): Fetch Note - [Update Note](https://developers.myclickfunnels.com/reference/updatesalesopportunitiesnotes.md): Update Note - [Remove Note](https://developers.myclickfunnels.com/reference/removesalesopportunitiesnotes.md): Remove Note - Segment - [List Segments](https://developers.myclickfunnels.com/reference/listsegments.md): List the workspace's contact segments, including those created in the UI. Standard cursor pagination, ordered by id ascending. Requires contacts:read. - [Create Segment](https://developers.myclickfunnels.com/reference/createsegments.md): Create a named contact audience from a saved or serialized contact filter, which the segment copies. Requires contacts:write. - [Fetch Segment](https://developers.myclickfunnels.com/reference/getsegments.md): Fetch a named contact audience. Requires contacts:read. - [Update Segment](https://developers.myclickfunnels.com/reference/updatesegments.md): Update a named contact audience. Requires contacts:write. Omitted update attributes retain their stored values. A filter_id with a different audience is copied into a new stored filter for the… - [Delete Segment](https://developers.myclickfunnels.com/reference/removesegments.md): Delete the segment, leaving its stored filter copy in place. Requires contacts:write. - Shipping::LocationGroup - [List Location Groups](https://developers.myclickfunnels.com/reference/listshippinglocationgroups.md): List location groups for a profile - [Fetch Location Group](https://developers.myclickfunnels.com/reference/getshippinglocationgroups.md): Retrieve a location group for a profile - Shipping::Package - [List Packages](https://developers.myclickfunnels.com/reference/listshippingpackages.md): List packages for a workspace - [Create Package](https://developers.myclickfunnels.com/reference/createshippingpackages.md): Add a new package to a workspace - [Fetch Package](https://developers.myclickfunnels.com/reference/getshippingpackages.md): Retrieve a package for a workspace - [Update Package](https://developers.myclickfunnels.com/reference/updateshippingpackages.md): Update a package for a workspace - [Remove Package](https://developers.myclickfunnels.com/reference/removeshippingpackages.md): Delete a package for a workspace - Shipping::Profile - [List Profiles](https://developers.myclickfunnels.com/reference/listshippingprofiles.md): List shipping profiles for a workspace - [Create Profile](https://developers.myclickfunnels.com/reference/createshippingprofiles.md): Add a new shipping profile to a workspace - [Fetch Profile](https://developers.myclickfunnels.com/reference/getshippingprofiles.md): Retrieve a shipping profile for a workspace - [Update Profile](https://developers.myclickfunnels.com/reference/updateshippingprofiles.md): Update a shipping profile for a workspace - [Remove Profile](https://developers.myclickfunnels.com/reference/removeshippingprofiles.md): Delete a shipping profile for a workspace - Shipping::Rate - [List Rates](https://developers.myclickfunnels.com/reference/listshippingrates.md): List shipping rates for a zone - [Create Rate](https://developers.myclickfunnels.com/reference/createshippingrates.md): Add a new shipping rate to a zone - [Fetch Rate](https://developers.myclickfunnels.com/reference/getshippingrates.md): Retrieve a shipping rate for a zone - [Update Rate](https://developers.myclickfunnels.com/reference/updateshippingrates.md): Update a shipping rate for a zone - [Remove Rate](https://developers.myclickfunnels.com/reference/removeshippingrates.md): Delete a shipping rate for a zone - Shipping::Zone - [List Zones](https://developers.myclickfunnels.com/reference/listshippingzones.md): List zones for a location group - [Create Zone](https://developers.myclickfunnels.com/reference/createshippingzones.md): Add a new zone to a location group - [Fetch Zone](https://developers.myclickfunnels.com/reference/getshippingzones.md): Retrieve a zone for a location group - [Update Zone](https://developers.myclickfunnels.com/reference/updateshippingzones.md): Update a zone for a location group - [Remove Zone](https://developers.myclickfunnels.com/reference/removeshippingzones.md): Delete a zone for a location group - Shipping::Rates::Name - [List Names](https://developers.myclickfunnels.com/reference/listshippingratesnames.md): List rate names for a shipping profile - [Create Name](https://developers.myclickfunnels.com/reference/createshippingratesnames.md): Add a new rate name to a shipping profile - [Fetch Name](https://developers.myclickfunnels.com/reference/getshippingratesnames.md): Retrieve a rate name for a shipping profile - [Update Name](https://developers.myclickfunnels.com/reference/updateshippingratesnames.md): Update a rate name for a shipping profile - [Remove Name](https://developers.myclickfunnels.com/reference/removeshippingratesnames.md): Delete a rate name for a shipping profile - Store - [List Stores](https://developers.myclickfunnels.com/reference/liststores.md): List Stores - [Create Store](https://developers.myclickfunnels.com/reference/createstores.md): Create Store - [Fetch Store](https://developers.myclickfunnels.com/reference/getstores.md): Fetch Store - [Update Store](https://developers.myclickfunnels.com/reference/updatestores.md): Update Store - [Remove Store](https://developers.myclickfunnels.com/reference/removestores.md): Remove Store - Style - [List Styles](https://developers.myclickfunnels.com/reference/liststyles.md): List Styles - SurveyWorkflow - [List Surveys](https://developers.myclickfunnels.com/reference/listsurveyworkflows.md): List a workspace's surveys, including disabled and archived ones. Each survey includes its current questions, the same as Fetch Survey. See the [Forms and surveys… - [Fetch Survey](https://developers.myclickfunnels.com/reference/getsurveyworkflows.md): Fetch a survey with every current question on every branch, including questions nobody has answered yet. Edit labels and choices through the linked Form resources; see the [Forms and surveys… - SurveyWorkflow::Run - [List Full Survey Responses](https://developers.myclickfunnels.com/reference/listsurveyworkflowsruns.md): List every run of a survey, one per respondent, with every saved answer. Filter by `status` or `contact_id`. The `survey_workflow_run.completed` webhook sends the same run object. See the [Forms and… - [Fetch Full Survey Response](https://developers.myclickfunnels.com/reference/getsurveyworkflowsruns.md): Fetch one survey run with every saved answer. The `survey_workflow_run.completed` webhook sends the same run object. See the [Forms and surveys… - Theme - [List Themes](https://developers.myclickfunnels.com/reference/listthemes.md): List of all themes available in the workspace - [Fetch Theme](https://developers.myclickfunnels.com/reference/getthemes.md): Retrieve a theme - [Update Theme](https://developers.myclickfunnels.com/reference/updatethemes.md): Update a theme - [Set Default Theme](https://developers.myclickfunnels.com/reference/set_defaultthemes.md): This will set the specified theme as the default theme for the current workspace. - UrlRedirect - [List Short Links](https://developers.myclickfunnels.com/reference/listurlredirects.md): List workspace short links with standard cursor pagination. Click counts are fetched separately. - [Create Short Link](https://developers.myclickfunnels.com/reference/createurlredirects.md): Create a short link. Explicit occupied paths return 422 without changing other resources; generated paths retain automatic disambiguation. Custom-domain roots are allowed only when unoccupied; the… - [Fetch Short Link](https://developers.myclickfunnels.com/reference/geturlredirects.md): Fetch a short link by numeric or public ID. - [Update Short Link](https://developers.myclickfunnels.com/reference/updateurlredirects.md): Update only supplied fields. Explicit occupied paths return 422 without suffixing or changing other resources. Changing domains with an omitted path also checks the retained path on the target domain… - [Delete Short Link](https://developers.myclickfunnels.com/reference/removeurlredirects.md) - [Check Short Link Availability](https://developers.myclickfunnels.com/reference/geturlredirectavailability.md): Read-only check of the normalized path against the same ownership and validation rules as writes. Does not reserve the path; writes recheck ownership. Another resource's current URL, historical alias… - [Fetch Short Link Stats](https://developers.myclickfunnels.com/reference/geturlredirectstats.md): Tracked short-link clicks, including repeated clicks from the same contact and existing bot exclusion. Defaults to the trailing 30 days, capped at 90 days. Future end is clamped to now; reversed… - Video - [List Videos](https://developers.myclickfunnels.com/reference/listvideos.md) - [Import Video](https://developers.myclickfunnels.com/reference/createvideos.md): Returns queued immediately. Download, MIME verification, metadata extraction and thumbnail generation run in the background. No URL deduplication. Poll GET /videos/{id} until ready or failed. - [Get Video](https://developers.myclickfunnels.com/reference/getvideos.md) - [Update Video](https://developers.myclickfunnels.com/reference/updatevideos.md): Also accepts PATCH. Only ready or failed videos may be changed. A re-import resets status to queued and error_code to null; attached lessons retain this video ID. - [Remove Video](https://developers.myclickfunnels.com/reference/removevideos.md): Removes the video and nullifies attached lessons video_id. - Webhooks::Incoming::ExternalPurchaseEndpoint - [List Incoming External Purchase Endpoints](https://developers.myclickfunnels.com/reference/listwebhooksincomingexternalpurchaseendpoints.md): List the endpoints that receive purchases from external commerce providers for a workspace. - [Create Incoming External Purchase Endpoint](https://developers.myclickfunnels.com/reference/createwebhooksincomingexternalpurchaseendpoints.md): Create an endpoint for one external commerce provider. Where ClickFunnels generates the signing secret, it is returned as `webhook_secret` in this response only, so save it immediately: later reads… - [Fetch Incoming External Purchase Endpoint](https://developers.myclickfunnels.com/reference/getwebhooksincomingexternalpurchaseendpoints.md): Retrieve one incoming external purchase endpoint. Only the last four characters of its signing secret are returned. - [Update Incoming External Purchase Endpoint](https://developers.myclickfunnels.com/reference/updatewebhooksincomingexternalpurchaseendpoints.md): Update the endpoint name or ClickFunnels email-suppression setting. Provider and live/test mode are immutable. For a Whop endpoint this is also where its `ws_` signing secret is set: create the… - [Remove Incoming External Purchase Endpoint](https://developers.myclickfunnels.com/reference/removewebhooksincomingexternalpurchaseendpoints.md): Delete an endpoint that has no retained events. Endpoints with event history cannot be deleted. For Whop, the webhook lives in the merchant's own Whop dashboard, so it stays untouched here and must… - Webhooks::Incoming::ExternalPurchaseEvent - [List Incoming External Purchase Events](https://developers.myclickfunnels.com/reference/listwebhooksincomingexternalpurchaseevents.md): List the raw events received by one incoming external purchase endpoint. Events can exist without a ClickFunnels order; in that case `order_id` is null. Read a single event to get its raw `payload`. - [Fetch Incoming External Purchase Event](https://developers.myclickfunnels.com/reference/getwebhooksincomingexternalpurchaseevents.md): Retrieve one raw external purchase event, its raw `payload` and its processing outcome. - Webhooks::Incoming::ExternalPurchaseProductMapping - [List Incoming External Purchase Product Mappings](https://developers.myclickfunnels.com/reference/listwebhooksincomingexternalpurchaseproductmappings.md): List the external product, plan, or SKU mappings configured for one incoming external purchase endpoint. - [Create Incoming External Purchase Product Mapping](https://developers.myclickfunnels.com/reference/createwebhooksincomingexternalpurchaseproductmappings.md): Map one provider product, plan, or SKU identifier to a ClickFunnels variant and price. Both ClickFunnels catalog records must belong to the endpoint's workspace and to the same product.… - [Fetch Incoming External Purchase Product Mapping](https://developers.myclickfunnels.com/reference/getwebhooksincomingexternalpurchaseproductmappings.md): Retrieve one external purchase product mapping and its ClickFunnels product, variant, and price labels. - [Update Incoming External Purchase Product Mapping](https://developers.myclickfunnels.com/reference/updatewebhooksincomingexternalpurchaseproductmappings.md): Update the external identifier, ClickFunnels variant, or ClickFunnels price for a mapping. - [Remove Incoming External Purchase Product Mapping](https://developers.myclickfunnels.com/reference/removewebhooksincomingexternalpurchaseproductmappings.md): Delete an external purchase product mapping. This does not delete its ClickFunnels product, variant, or price. - Webhooks::Outgoing::Endpoint - [List Endpoints](https://developers.myclickfunnels.com/reference/listwebhooksoutgoingendpoints.md): List webhook endpoints for a workspace - [Create Endpoint](https://developers.myclickfunnels.com/reference/createwebhooksoutgoingendpoints.md): Add a new webhook endpoint to a workspace - [Fetch Endpoint](https://developers.myclickfunnels.com/reference/getwebhooksoutgoingendpoints.md): Retrieve a webhook endpoint for a workspace - [Update Endpoint](https://developers.myclickfunnels.com/reference/updatewebhooksoutgoingendpoints.md): Update a webhook endpoint for a workspace - [Remove Endpoint](https://developers.myclickfunnels.com/reference/removewebhooksoutgoingendpoints.md): Delete a webhook endpoint for a workspace - Webhooks::Outgoing::Event - [List Events](https://developers.myclickfunnels.com/reference/listwebhooksoutgoingevents.md): List webhook events for a workspace - [Fetch Event](https://developers.myclickfunnels.com/reference/getwebhooksoutgoingevents.md): Retrieve an webhook event for a workspace - Webhooks::Outgoing::EventType - [List Event Types](https://developers.myclickfunnels.com/reference/listwebhooksoutgoingeventtypes.md): Returns the complete, authoritative catalog of webhook event types that a webhook endpoint can subscribe to. Each entry's `id` field is the exact dotted/slashed string key (e.g. `contact.updated`,… - Workflow - [List Workflows](https://developers.myclickfunnels.com/reference/listworkflows.md): List the standalone automation workflows for a workspace. Supports cursor pagination and sort. - [Create Workflow](https://developers.myclickfunnels.com/reference/createworkflow.md): Create a new standalone automation workflow. New workflows are created in the `draft` state (disabled). Add triggers and steps, then call `POST /workflows/{id}/enable` to make it live. - [Fetch Workflow](https://developers.myclickfunnels.com/reference/getworkflow.md): Retrieve a single workflow by its integer id or obfuscated public_id. - [Update Workflow](https://developers.myclickfunnels.com/reference/updateworkflow.md): Update a workflow's `name`, `archived` flag or `run_type`. Changing `run_type` does not affect runs already in progress; it decides how each contact's next enrollment is handled. A `run_type` outside… - [Delete Workflow](https://developers.myclickfunnels.com/reference/deleteworkflow.md): Permanently delete a workflow and all its associated triggers, steps, and run records. - [Fetch Workflow Structure](https://developers.myclickfunnels.com/reference/getworkflowstructure.md): Returns the workflow's complete tree in a single call: the workflow header, its active triggers (summary shape), and the ordered list of visible steps with branching inlined. Internal container nodes… - [Enable Workflow](https://developers.myclickfunnels.com/reference/enableworkflow.md): Enable a workflow so it can accept new runs. The workflow must have at least one active trigger — otherwise returns 422. Returns the updated workflow. - [Disable Workflow](https://developers.myclickfunnels.com/reference/disableworkflow.md): Disable a workflow, stopping new runs from being started. In-progress runs are canceled. Returns the updated workflow. - Workflows::Trigger - [List Triggers](https://developers.myclickfunnels.com/reference/listworkflowtriggers.md): List all triggers attached to a workflow. - [Create Trigger](https://developers.myclickfunnels.com/reference/createworkflowtrigger.md): Add a new trigger to a workflow. The `event_type_key` must be a valid workflow trigger event key — an invalid value returns 422. All condition FK fields accept the integer id or obfuscated… - [Fetch Trigger](https://developers.myclickfunnels.com/reference/getworkflowtrigger.md): Retrieve a single workflow trigger. - [Update Trigger](https://developers.myclickfunnels.com/reference/updateworkflowtrigger.md): Update an existing workflow trigger. All fields optional. An invalid `event_type_key` returns 422. As on create, a trigger field nested in another object, sent beside `workflows_trigger`, or given an… - [Delete Trigger](https://developers.myclickfunnels.com/reference/deleteworkflowtrigger.md): Delete a trigger from a workflow. - Workflows::Step - [List Steps](https://developers.myclickfunnels.com/reference/listworkflowsteps.md): List all visible (displayable) steps for a workflow using standard collection sorting. Internal container nodes are not included. `sort_order` is container-local and not globally unique; use `GET… - [Create Step](https://developers.myclickfunnels.com/reference/createworkflowstep.md): Add a new step to a workflow. `step_type_settings` must contain exactly one key naming the step type. **Placement:** omit `parent_step_id` to append to the trunk sequence. Set `parent_step_id` +… - [Fetch Step](https://developers.myclickfunnels.com/reference/getworkflowstep.md): Retrieve a single workflow step. - [Update Step](https://developers.myclickfunnels.com/reference/updateworkflowstep.md): Update a workflow step's `name`, `step_type_settings`, and/or placement. Moving split steps (`conditional_split_step`, `split_test_step`) is not supported and returns 422. A `send_email_step`'s… - [Delete Step](https://developers.myclickfunnels.com/reference/deleteworkflowstep.md): Delete a step from a workflow. Split steps and their branch contents are removed recursively. - [Fetch Workflow Step Stats](https://developers.myclickfunnels.com/reference/getworkflowstepstats.md): Stats for one workflow step — the numbers the workflow builder shows under it. Every step type reports `contacts`: how many are at the step right now and how many left it inside the window. A… - Workflows::Run - [List Runs](https://developers.myclickfunnels.com/reference/listworkflowruns.md): List automation runs for a workflow, with compact contact data in each run. Filter by `current_step_id` to see who is at a step now, including paused runs. Multiple step IDs are ORed; `contact_id`… - [Enroll Contact (Create Run)](https://developers.myclickfunnels.com/reference/createworkflowrun.md): Manually enroll a contact into a workflow, starting a new run immediately. The workflow must be enabled (`status: live`) — an unenabled workflow returns 422. The contact must belong to the same… - [Fetch Run](https://developers.myclickfunnels.com/reference/getworkflowrun.md): Retrieve a single workflow run by its id or obfuscated public_id. ## Changelog - [Page markup inputs label themselves, keep padding, and name custom fields](https://developers.myclickfunnels.com/changelog/page-markup-input-label-padding-and-custom-name.md) - [A page funnel block that is not an object returns a validation error instead of a 500](https://developers.myclickfunnels.com/changelog/page-funnel-block-that-is-not-an-object-returns-a-validation-error-instead-of-a-500.md) - [Workflow step settings with an unknown option return a validation error instead of a 500](https://developers.myclickfunnels.com/changelog/workflow-step-enum-settings-return-a-validation-error-instead-of-a-500.md) - [A replaced image shows up at its URL within minutes](https://developers.myclickfunnels.com/changelog/a-replaced-image-shows-up-at-its-url-within-minutes.md) - [Create Image and Update Image return the image's permanent URL](https://developers.myclickfunnels.com/changelog/create-and-update-image-return-the-permanent-url.md) - [Contact filter generation reports criteria it cannot resolve](https://developers.myclickfunnels.com/changelog/contact-filter-generation-reports-unresolved-criteria.md) - [Read the HTML a broadcast actually sent](https://developers.myclickfunnels.com/changelog/read-the-html-a-broadcast-actually-sent.md) - [Split-test results per variant](https://developers.myclickfunnels.com/changelog/split-test-results-per-variant.md) - [A workspace can have up to 400 webhook endpoints](https://developers.myclickfunnels.com/changelog/webhook-endpoint-limit-per-workspace.md) - [Read full survey responses and receive a webhook when a survey is completed](https://developers.myclickfunnels.com/changelog/read-full-survey-responses-and-receive-completion-webhooks.md)