- Category: marketing automation
- Auth: OAUTH2, API_KEY
- Composio-managed OAuth available? No
- Tools: 476
- Triggers: 0
- Slug:
CLICKFUNNELS - Version: 20261101_00
Tools
Abandon Invoice
Abandon Invoice
Approve Post
Approve Post
Approve Comment
Approve Comment
Archive Email Topic
Archive Email Topic
Archive a Funnel
Archive a Funnel
CLICKFUNNELS_ARCHIVE_FUNNELSArchive a Funnel. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.Output
Archive a Product
Archive a Product
Cancel a Fulfillment
Cancel a Fulfillment
Cancel Order
Cancel Order
CLICKFUNNELS_CANCEL_ORDERCancel Order. This can trigger an irreversible external effect. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
API.other. Valid values are processor-specific; a value that isn’t accepted for the order’s processor returns a 422. Stripe orders accept: customer_service, low_quality, missing_features, other, switched_service, too_complex, too_expensive, unused Payments AI (Rebilly) orders accept: did-not-use, did-not-want, missing-features, too-expensive, bugs-or-problems, othernext_renewal: cancels at the end of the current paid period. Access is retained until paid_until. - Any other value: cancels immediately. When omitted, it cancels immediately if the order’s current period was never paid for (billing_status is unpaid, past-due, delinquent, failed, voided, abandoned or disputed), and at next_renewal otherwise. See Cancel a subscription in the Orders Skill for how the period-end and immediate cancels differ and which fields settle later.unpaid or past-due) invoices are voided, so the payment processor stops retrying them. Send [] to keep them open. Any other value, such as null or a single id outside an array, returns a 422.Output
Create Blog Post
Create Blog Post
CLICKFUNNELS_CREATE_BLOG_POSTCreate Blog Post. API access tokens need blog:write permission; the coarse write permission also authorizes this action.Input Parameters
markup to leave the body untouched. Validation occurs before any database write; invalid or mid-construct/truncated markup returns 400 without creating or updating the post. Re-send the complete document, not only the missing tail. Raw HTML is not PML; normalize and wrap it for PML. See the Page Markup Skill for the DSL, approval guardrail, and normalization rules.expand[]=markup to include the PML markup for the post’s visual content. Markup is opt-in on every endpoint (show, list, create, update) because PML serialization runs per post. See the Expanding guide for available fields and examples.draft, public, members_only, or scheduled. See Two gotchas worth knowing in the Blogs Skill.scheduled. See Publish separately in the Import External Blog Post Skill.Output
Create Blog Tag
Create Blog Tag
Create Community
Create Community
Create Ban
Create Ban
Create Ban Export Action
Create Ban Export Action
Create Ban Unban Action
Create Ban Unban Action
Create Membership
Create Membership
CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPSCreate Membership. API access tokens need community:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Membership Add-To-Group Action
Create Membership Add-To-Group Action
Create Membership Ban Action
Create Membership Ban Action
Create Membership Export Action
Create Membership Export Action
Create Membership Remove-From-Group Action
Create Membership Remove-From-Group Action
CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPS_REMOVE_FROM_GROUP_ACTIONSCreate Membership Remove-From-Group Action. This can trigger an irreversible external effect. API access tokens need community:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Space Group
Create Space Group
Create Space
Create Space
Create Post
Create Post
Create Comment
Create Comment
CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTS_COMMENTSCreate Comment. API access tokens need community:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Comment Like
Create Comment Like
CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTS_COMMENTS_LIKESCreate Comment Like. API access tokens need community:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Post Like
Create Post Like
CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTS_LIKESCreate Post Like. API access tokens need community:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Video Embed
Create Video Embed
CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTS_VIDEO_EMBEDSCreate Video Embed. API access tokens need community:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Contact
Create Contact
CLICKFUNNELS_CREATE_CONTACTSCreate Contact. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.snake_case (For example, ‘Favorite Food! 🥑’ will be converted to ‘favorite_food’). Empty keys will trigger a bad request response. Also, non-object inputs for custom_attributes (e.g. an array or string), it will be ignored. Keys that are default properties on the Contact resource or variations of it will result in an error. E.g., ‘first_name’, ‘First Name’, etc. are not valid inputs.Output
Create Applied Tag
Create Applied Tag
Create contact billing address
Create contact billing address
Create Enroll Action
Create Enroll Action
CLICKFUNNELS_CREATE_CONTACTS_ENROLL_ACTIONSCreate Enroll Action. This can trigger an irreversible external effect. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
stable_id token — the standard gzip+base64 full-state format used by both the contacts/filters API endpoint and the server-rendered filter UI, making tokens interoperable. Returned by POST /api/v2/workspaces/{workspace_id}/contacts/filters in the stable_id field. Pass the token exactly as returned; do not decode or re-encode it. The server persists the decoded filter so the async job can re-derive the audience at perform time. Mutually exclusive with stored_filter_id, target_ids, and target_all.course_ids, section_ids, or both.true to target every contact in the workspace. Use deliberately. Mutually exclusive with stable_id, stored_filter_id, and target_ids.public_id strings returned by the contacts endpoints. Numeric ids are also accepted. Mutually exclusive with stable_id, stored_filter_id, and target_all.course_ids.null) to execute immediately.id (integer) or public_id (string) of a saved Refine::StoredFilter scoped to this workspace (must be a ContactsFilter). Also accepted as filter_id. Mutually exclusive with stable_id, target_ids, and target_all.Output
Create Contact Activity Note
Create Contact Activity Note
CLICKFUNNELS_CREATE_CONTACTS_EVENTS_NOTESCreate Contact Activity Note. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Export Action
Create Export Action
CLICKFUNNELS_CREATE_CONTACTS_EXPORT_ACTIONSCreate Export Action. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
email_address, first_name, last_name, tag_ids, phone_number, etc. Custom attribute keys are also accepted. Required.stable_id token — the standard gzip+base64 full-state format used by both the contacts/filters API endpoint and the server-rendered filter UI, making tokens interoperable. Returned by POST /api/v2/workspaces/{workspace_id}/contacts/filters in the stable_id field. Pass the token exactly as returned; do not decode or re-encode it. The server persists the decoded filter so the async job can re-derive the audience at perform time. Mutually exclusive with stored_filter_id, target_ids, and target_all.true to target every contact in the workspace. Use deliberately. Mutually exclusive with stable_id, stored_filter_id, and target_ids.public_id strings returned by the contacts endpoints. Numeric ids are also accepted. Mutually exclusive with stable_id, stored_filter_id, and target_all.null) to execute immediately.id (integer) or public_id (string) of a saved Refine::StoredFilter scoped to this workspace (must be a ContactsFilter). Also accepted as filter_id. Mutually exclusive with stable_id, target_ids, and target_all.Output
Create Run Workflow Action
Create Run Workflow Action
CLICKFUNNELS_CREATE_CONTACTS_RUN_WORKFLOW_ACTIONSCreate Run Workflow Action. This can trigger an irreversible external effect. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
stable_id token — the standard gzip+base64 full-state format used by both the contacts/filters API endpoint and the server-rendered filter UI, making tokens interoperable. Returned by POST /api/v2/workspaces/{workspace_id}/contacts/filters in the stable_id field. Pass the token exactly as returned; do not decode or re-encode it. The server persists the decoded filter so the async job can re-derive the audience at perform time. Mutually exclusive with stored_filter_id, target_ids, and target_all.true to target every contact in the workspace. Use deliberately. Mutually exclusive with stable_id, stored_filter_id, and target_ids.public_id strings returned by the contacts endpoints. Numeric ids are also accepted. Mutually exclusive with stable_id, stored_filter_id, and target_all.null) to execute immediately.id (integer) or public_id (string) of a saved Refine::StoredFilter scoped to this workspace (must be a ContactsFilter). Also accepted as filter_id. Mutually exclusive with stable_id, target_ids, and target_all.Output
Create Tag Action
Create Tag Action
CLICKFUNNELS_CREATE_CONTACTS_TAG_ACTIONSCreate a tag action to add or remove tags on selected contacts in a workspace. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
public_id strings identifying existing tags to apply or remove. Every id must reference a tag that already exists in this workspace; unknown ids are rejected with a 422 (tags are not auto-created).stable_id token — the standard gzip+base64 full-state format used by both the contacts/filters API endpoint and the server-rendered filter UI, making tokens interoperable. Returned by POST /api/v2/workspaces/{workspace_id}/contacts/filters in the stable_id field. Pass the token exactly as returned; do not decode or re-encode it. The server persists the decoded filter so the async job can re-derive the audience at perform time. Mutually exclusive with stored_filter_id, target_ids, and target_all.true to target every contact in the workspace. Use deliberately. Mutually exclusive with stable_id, stored_filter_id, and target_ids.public_id strings returned by the contacts endpoints (e.g. "aB3cD4") — the same id format used everywhere else in this API. Numeric ids are also accepted. Mutually exclusive with stable_id, stored_filter_id, and target_all.null) to execute immediately.id (integer) or public_id (string) of a saved Refine::StoredFilter scoped to this workspace (must be a ContactsFilter). Also accepted as filter_id. Mutually exclusive with stable_id, target_ids, and target_all.Output
Create Tag
Create Tag
Create Unsubscribe Action
Create Unsubscribe Action
CLICKFUNNELS_CREATE_CONTACTS_UNSUBSCRIBE_ACTIONSCreate Unsubscribe Action. This can trigger an irreversible external effect. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
stable_id token — the standard gzip+base64 full-state format used by both the contacts/filters API endpoint and the server-rendered filter UI, making tokens interoperable. Returned by POST /api/v2/workspaces/{workspace_id}/contacts/filters in the stable_id field. Pass the token exactly as returned; do not decode or re-encode it. The server persists the decoded filter so the async job can re-derive the audience at perform time. Mutually exclusive with stored_filter_id, target_ids, and target_all.true to target every contact in the workspace. Use deliberately. Mutually exclusive with stable_id, stored_filter_id, and target_ids.public_id strings returned by the contacts endpoints. Numeric ids are also accepted. Mutually exclusive with stable_id, stored_filter_id, and target_all.null) to execute immediately.id (integer) or public_id (string) of a saved Refine::StoredFilter scoped to this workspace (must be a ContactsFilter). Also accepted as filter_id. Mutually exclusive with stable_id, target_ids, and target_all.Output
Opt a Contact out of a Topic
Opt a Contact out of a Topic
Create Course
Create Course
Create Enrollment
Create Enrollment
Create Lesson Completion
Create Lesson Completion
Create Lesson
Create Lesson
CLICKFUNNELS_CREATE_COURSES_LESSONSCreate Lesson. API access tokens need courses:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Section
Create Section
Create Publish Action
Create Publish Action
CLICKFUNNELS_CREATE_COURSES_SECTIONS_PUBLISH_ACTIONSCreate a course-section publish action, which can trigger an irreversible external effect. API access tokens need courses:write permission; the coarse write permission also authorizes this action.Input Parameters
true (requires auto_enroll: true), enrolled contacts receive an email notification about the newly published sections.true to publish every unpublished non-root section of the course. Mutually exclusive with target_ids. Exactly one of target_all or target_ids must be supplied.target_all. Exactly one of target_ids or target_all must be supplied.true, existing course enrollees are granted access to the newly published sections automatically.true, products that grant full course access are updated to also include the newly published sections.Output
Create Custom HTML Page
Create Custom HTML Page
CLICKFUNNELS_CREATE_CUSTOM_HTML_PAGECreate Custom HTML Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
funnel_id or show_page_step_id. Omit the whole block to create a standalone page.funnel.funnel_id (422 without it). 0 inserts before the first step; omit to append. Ignored when funnel.show_page_step_id is used./my-landing). Derived from the name when omitted.Output
Create Discount
Create Discount
CLICKFUNNELS_CREATE_DISCOUNTSCreate Discount. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
code-type discount. Letters, numbers and hyphens only - spaces, underscores and punctuation return 422. Uppercased on save; must be unique within the workspace (it cannot collide with a coupon code either).all_products.expired create field - sending one returns 422 whatever its value, including false, because expiring on create can never succeed (it would set apply_until to now, and apply_from then defaults to a hair later). Create the discount first, then expire it with PATCH { "discount": { "expired": true } }.percentage. percentage requires percent; fixed requires a positive amount.50 on a usd discount means $50. Must be positive when require_minimum_spend is true.Output
Create Email Address
Create Email Address
CLICKFUNNELS_CREATE_EMAILS_ADDRESSESCreate Email Address. API access tokens need emails:write permission; the coarse write permission also authorizes this action.Input Parameters
clickfunnelsmail.com). This is not how you use your own domain: putting a custom name here neither provisions nor authenticates it, and the request is rejected with 422 unless emails_domain_id is also given. To send from your own domain, provision it first and pass its numeric id as emails_domain_id, which is what the address is then created on.id (not public_id) of a custom sending domain belonging to this workspace. Use the Email Domains endpoints to provision it and wait until that domain is ready to send before sending from the resulting address.Output
Create Email Broadcast
Create Email Broadcast
CLICKFUNNELS_CREATE_EMAILS_BROADCASTCreate Email Broadcast. API access tokens need emails:write permission; the coarse write permission also authorizes this action.Input Parameters
id or the public id (string) of a saved contact filter (Refine::StoredFilter) in this workspace, or a serialized contact filter. The supplied filter is copied onto the broadcast — the broadcast points at its own copy, so later edits to (or deletion of) the saved filter never change this broadcast’s audience. Saved contact filters can be created/listed via the Refine Filters Skill. If recipients are provided instead, a filter is created automatically from them and takes precedence over filter_id. See Applying filters to email broadcasts.usable_as_sender: true or the send is rejected with 422. Do not pick by the sending domain’s verified flag: that covers email transport only. See GET /workspaces/{workspace_id}/emails/addresses, where a shared workspace-default address is usable only while the workspace has no ready custom sender.variants. When enabled without stored settings, percentage defaults to 100 and wait time defaults to 0 hours. Must be a JSON boolean - string spellings such as "true" return 422.true: send false explicitly to deliver the whole audience in one go. Above 5,000 recipients Smart Sending is mandatory: sending false is accepted and may be stored as true. The send batches at that size regardless of the stored value.usable_as_sender is true.smart_sending_units the delivery window spans, for example 2 with hour. Must be between 0.5 and 100, and must be sent together with smart_sending_unit. Omit both to size the window from the audience, which is the recommended default.smart_sending_time. Omit both to size the window from the audience, which is the recommended default.Output
Create Send Action
Create Send Action
CLICKFUNNELS_CREATE_EMAILS_BROADCASTS_SEND_ACTIONSCreate Send Action. This can trigger an irreversible external effect. API access tokens need emails:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Email Domain
Create Email Domain
CLICKFUNNELS_CREATE_EMAILS_DOMAINSCreate Email Domain. API access tokens need emails:write permission; the coarse write permission also authorizes this action.Input Parameters
example.com), with no URL scheme, port, path, or whitespace. Ownership is confirmed at the root domain, so a subdomain such as mail.example.com is rejected with 422 naming the root domain to use instead. The name is trimmed and lowercased before it is matched or created. If a sending domain with this name already exists for the workspace, it is returned as-is rather than creating a duplicate.Output
Create Email Template
Create Email Template
CLICKFUNNELS_CREATE_EMAILS_TEMPLATECreate Email Template. API access tokens need emails:write permission; the coarse write permission also authorizes this action.Input Parameters
usable_as_sender is true rather than one whose sending domain is merely verified (see GET /workspaces/{workspace_id}/emails/addresses). A foreign address is rejected with 422.Output
Create Email Topic
Create Email Topic
Create External Page
Create External Page
CLICKFUNNELS_CREATE_EXTERNAL_PAGECreate External Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
funnel_id or show_page_step_id. Omit the whole block to create a standalone external page (no funnel step).funnel.funnel_id (422 without it). 0 inserts before the first step; omit to append. Ignored when funnel.show_page_step_id is used.https://acme.example.com/my-page). Must be unique within the workspace.Output
Create Form
Create Form
Create Field
Create Field
Create Field Set
Create Field Set
Create Option
Create Option
Create Submission
Create Submission
Create Answer
Create Answer
Create Fulfillment
Create Fulfillment
Create Location
Create Location
CLICKFUNNELS_CREATE_FULFILLMENTS_LOCATIONSCreate Location. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Funnel
Create Funnel
CLICKFUNNELS_CREATE_FUNNELCreate Funnel. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Conditional Split Step
Create Conditional Split Step
CLICKFUNNELS_CREATE_FUNNEL_CONDITIONAL_SPLIT_STEPCreate Conditional Split Step. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
branches[0] is the matched branch, branches[1] is the unmatched branch.show_page_step. Accepts a numeric Workflows::Steps::ShowPageStep id or its obfuscated public id (you can read either off any page response). When omitted, the split lands at funnel entry. Caution: creating a split moves the wrapped step inside a branch sequence, so an id fetched earlier may no longer sit where you think — read the funnel structure immediately before creating, and note that anchoring on a step inside another split’s branch nests the new split in that branch.Output
Duplicate Funnel Asynchronously
Duplicate Funnel Asynchronously
Create Split Test Step
Create Split Test Step
CLICKFUNNELS_CREATE_FUNNEL_SPLIT_TEST_STEPCreate Split Test Step. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
show_page_step. Accepts a numeric Workflows::Steps::ShowPageStep id or its obfuscated public id (you can read either off any page response). When omitted, the split lands at funnel entry. Caution: creating a split moves the wrapped step inside a branch sequence, so an id fetched earlier may no longer sit where you think — read the funnel structure immediately before creating, and note that anchoring on a step inside another split’s branch nests the new split in that branch.Output
Create Tag
Create Tag
Create Image
Create Image
Create External Order
Create External Order
CLICKFUNNELS_CREATE_ORDERSCreate External Order. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
true: The order is a live/production order. - false: The order is a test order.contact_id or contact_attributes must be provided, but not both. If both are provided, contact_id takes precedence.one-time-order: A single purchase order. Line items must reference one-time products only. - subscription-order: A recurring subscription order. Line items can include both one-time and subscription products.did-not-use, did-not-want, missing-features, too-expensive, bugs-or-problems, other Possible codes for Stripe orders are: customer_service, low_quality, missing_features, other, switched_service, too_complex, too_expensive, unused External orders accept the same cancelation reasons as Stripe.pending, draft, paid, unpaid, partially-refunded, refunded, voided, disputed, past-due. For external orders, the billing status can be one of: pending, paid, unpaid, voided and refunded.pending, active, completed, churned, canceled, suspended, paused, abandoned, voided Stripe orders have the same order statuses, except for voided. For voided invoices, its service status becomes abandoned. You can read about the state transitions in more detail in our orders overview guide. For external one-time orders possible service statuses are pending or completed. For external subscription orders possible statuses are pending, active, churned, canceled, completed, paused.contact_id. Provide contact attributes to look up an existing contact by email. The contact must already exist in the workspace - by default, this does not create new contacts. If contact_id is also provided, it takes precedence and contact_attributes is ignored.variant_id, products_price_id, and quantity.Output
Create Applied Tag
Create Applied Tag
Create External Invoice
Create External Invoice
CLICKFUNNELS_CREATE_ORDERS_INVOICESCreate External Invoice. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
unpaid, paid, voided, refunded, disputed, past-due. For external subscription orders, the same statuses apply. When creating an invoice with status paid, you must also provide paid_at. A change in status will update the billing_status of the parent order. If a one-time order’s invoice status is changed to paid, the order’s service_status will also flip to completed.one_time_sale - For subscription orders: initial For subscription orders, valid types are: initial, renewal, interim, cancellation, one_time, refund, charge. For one-time orders, only one_time_sale is valid.amount, quantity, variant_id, products_price_id.Output
Create Tag
Create Tag
Create Page
Create Page
CLICKFUNNELS_CREATE_PAGECreate Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields (e.g., expand[]=head_code&expand[]=footer_code&expand[]=custom_css&expand[]=markup). Markup is opt-in on every endpoint (show, list, create, update) because PML serialization runs per page. custom_css is available on internal pages only. See the Expanding guide for available fields and examples. Read a page’s existing markup with expand[]=markup before editing it: see Reading Current Markup in the Pages Skill.<customhtml> body that never closes, or elements still open at the end of the document) is rejected with a 400 and the page is not created — re-send the complete document rather than the missing tail. See the Page Markup Skill for the full DSL reference. The parser errors are listed under Common Validation Errors.funnel.funnel_id. 0 inserts before the first step; omit to append at the end. Ignored when funnel.show_page_step_id is provided. Out-of-bounds values return 422.current_path) in the Pages Skill for the path rules.funnel block above. Only valid when the page is also being linked to a funnel via the funnel block — passing show_page_step.product_ids or show_page_step.bumps without a funnel link returns 400.Output
Create Product
Create Product
CLICKFUNNELS_CREATE_PRODUCTSCreate Product. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
Products::Variant resource).Output
Create Collection
Create Collection
CLICKFUNNELS_CREATE_PRODUCTS_COLLECTIONSCreate Collection. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Price
Create Price
CLICKFUNNELS_CREATE_PRODUCTS_PRICESCreate Price. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
GET /products/prices/{price_id}/change_options lists the upgrades and downgrades the API allows from this price.GET /products/prices/{price_id}/change_options lists the upgrades and downgrades the API allows from this price.Output
Create Tag
Create Tag
Create Variant
Create Variant
CLICKFUNNELS_CREATE_PRODUCTS_VARIANTSCreate Variant. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
has_access_to_all_valid_assets (set it false to grant only these). On update this replaces the current set.Product.physical or digital. Drives checkout behavior: a physical variant makes checkout collect a shipping address (and shipping options); a digital variant skips both. Unset behaves like digital at checkout, so set it to match the real-world goods.course_id; a purchase grants access to it. When creating a grant, omit included_sections_attributes for FULL-course access, or list specific sections for PARTIAL access. On an existing grant, omitting sections does NOT convert partial access to full; manage sections explicitly (add via courses_section_id, remove via id + _destroy). To revoke the whole grant, pass its id with _destroy set to true.asset_ids to grant only specific ones.communities_space_group_id; a purchase grants access to the whole group. To revoke, pass the grant’s id with _destroy set to true.Output
Create Opportunity
Create Opportunity
CLICKFUNNELS_CREATE_SALES_OPPORTUNITIESCreate Opportunity. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.Input Parameters
Membership to assign the Opportunity to. An Opportunity can be assigned to any Team member since they have access to all your workspaces. You can get a list of available Memberships and their id via the Team resource’s memberships property. If the opportunity is already assigned to a team member, the assignee will be updated. You can unset the assignee by passing a null value for assignee_id.Output
Create Note
Create Note
CLICKFUNNELS_CREATE_SALES_OPPORTUNITIES_NOTESCreate Note. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Pipeline
Create Pipeline
Create Stage
Create Stage
CLICKFUNNELS_CREATE_SALES_PIPELINES_STAGESCreate Stage. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Segment
Create Segment
CLICKFUNNELS_CREATE_SEGMENTSCreate Segment. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
true for ids only; omit for the filter definition alone.Output
Create shipping addresses
Create shipping addresses
CLICKFUNNELS_CREATE_SHIPPING_ADDRESSESCreate shipping addresses. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Package
Create Package
Create Profile
Create Profile
Create Rate
Create Rate
Create Name
Create Name
Create Zone
Create Zone
Create Store
Create Store
Create Short Link
Create Short Link
CLICKFUNNELS_CREATE_URL_REDIRECTSCreate Short Link. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Incoming External Purchase Endpoint
Create Incoming External Purchase Endpoint
CLICKFUNNELS_CREATE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_ENDPOINTSCreate Incoming External Purchase Endpoint. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Incoming External Purchase Product Mapping
Create Incoming External Purchase Product Mapping
Create Endpoint
Create Endpoint
CLICKFUNNELS_CREATE_WEBHOOKS_OUTGOING_ENDPOINTSCreate Endpoint. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.Input Parameters
page_ids pass an empty array or null.funnel_ids pass an empty array or null.contact.updated, order.completed, orders/invoice.paid) — these are NOT numeric IDs. Retrieve the full list of valid keys from GET /api/v2/webhooks/outgoing/event_types (operationId: listWebhooksOutgoingEventTypes). The <a class=“link” href=“https://developers.myclickfunnels.com/docs/webhook-event-types” target=“_blank”>Webhook Event Types guide</a> provides supplementary context. On create, one or more valid event_type_ids are required. To remove one event_type_id on update, pass an array of all current event_type_ids less the one to be removed. On update to remove all event_type_ids pass an empty array.Output
Create Workflow
Create Workflow
Enroll Contact (Create Run)
Enroll Contact (Create Run)
CLICKFUNNELS_CREATE_WORKFLOW_RUNEnroll Contact (Create Run). API access tokens need workflows:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Create Step
Create Step
CLICKFUNNELS_CREATE_WORKFLOW_STEPCreate Step. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.Input Parameters
matched/unmatched for conditional splits (legacy match/fallback still accepted); "0"/"1" for split tests.send_email_step a template_id is copied into a new step-owned template, and you may instead pass the write-only html_body/text_body to author one inline. See the step_type_settings field on the Workflows::Step response schema (#/components/schemas/WorkflowsStepAttributes) for the full per-type field catalog, the send_email_step inline-body rules, and FK id handling.Output
Create Trigger
Create Trigger
CLICKFUNNELS_CREATE_WORKFLOW_TRIGGERCreate Trigger. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.Input Parameters
$contact.tag_applied). Must be one of the enumerated keys.Output
Create Refine Filter
Create Refine Filter
Decline Post
Decline Post
Decline Comment
Decline Comment
Delete Blog Post
Delete Blog Post
Remove Ban
Remove Ban
Remove Membership
Remove Membership
Remove Space Group
Remove Space Group
Remove Space
Remove Space
Remove Post
Remove Post
Remove Comment
Remove Comment
Remove Comment Like
Remove Comment Like
Remove Post Like
Remove Post Like
Remove Video Embed
Remove Video Embed
Remove Contact
Remove Contact
Remove Applied Tag
Remove Applied Tag
Remove Enroll Action
Remove Enroll Action
Delete Contact Activity Note
Delete Contact Activity Note
Remove Export Action
Remove Export Action
Remove Run Workflow Action
Remove Run Workflow Action
Remove Tag Action
Remove Tag Action
Remove Tag
Remove Tag
Remove Unsubscribe Action
Remove Unsubscribe Action
Resubscribe a Contact to a Topic
Resubscribe a Contact to a Topic
Remove Lesson Completion
Remove Lesson Completion
Remove Publish Action
Remove Publish Action
Remove Discount
Remove Discount
Archive Email Address
Archive Email Address
Delete Email Broadcast
Delete Email Broadcast
Remove Send Action
Remove Send Action
Delete Email Template
Delete Email Template
Remove Form
Remove Form
Remove Field
Remove Field
Remove Field Set
Remove Field Set
Remove Option
Remove Option
Remove Submission
Remove Submission
Remove Answer
Remove Answer
Remove Fulfillment
Remove Fulfillment
Remove Location
Remove Location
Remove Tag
Remove Tag
Remove Image
Remove Image
Remove Applied Tag
Remove Applied Tag
Remove Tag
Remove Tag
Delete Page
Delete Page
Remove Products from Page
Remove Products from Page
Remove Tag
Remove Tag
Remove Opportunity
Remove Opportunity
Remove Note
Remove Note
Remove Pipeline
Remove Pipeline
Remove Stage
Remove Stage
Delete Segment
Delete Segment
Remove shipping addresses
Remove shipping addresses
Remove Package
Remove Package
Remove Profile
Remove Profile
Remove Rate
Remove Rate
Remove Name
Remove Name
Remove Zone
Remove Zone
Remove Store
Remove Store
Delete Short Link
Delete Short Link
Remove Incoming External Purchase Endpoint
Remove Incoming External Purchase Endpoint
Remove Incoming External Purchase Product Mapping
Remove Incoming External Purchase Product Mapping
CLICKFUNNELS_DELETE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_PRODUCT_MAPPINGSRemove Incoming External Purchase Product Mapping. This permanently removes the targeted resource. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Remove Endpoint
Remove Endpoint
Delete Workflow
Delete Workflow
Delete Step
Delete Step
Delete Trigger
Delete Trigger
Destroy Conditional Split Step
Destroy Conditional Split Step
CLICKFUNNELS_DESTROY_FUNNEL_CONDITIONAL_SPLIT_STEPDelete a funnel conditional split step or a selected branch. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
matched, unmatched, or both (default).Output
Delete an empty Funnel
Delete an empty Funnel
Destroy Split Test Step
Destroy Split Test Step
Destroy Refine Filter
Destroy Refine Filter
Disable Workflow
Disable Workflow
Dismiss Reports on Post
Dismiss Reports on Post
Dismiss Comment Reports
Dismiss Comment Reports
Enable Workflow
Enable Workflow
Redact Contact
Redact Contact
Generate a Contact Filter
Generate a Contact Filter
CLICKFUNNELS_GENERATE_CONTACT_FILTERGenerate a Contact Filter. Set save=true only when the generated filter should be persisted. API access tokens need contacts:read (or broader read) permission; save=true additionally needs contacts:write (or coarse write) permission.Input Parameters
save is true. Must be unique within the workspace when provided.true, persists the generated filter as a reusable Refine::StoredFilter. The saved filter identity fields are included in the response. Requires write access to the Contacts category (generating without save needs only read).true for ids only; omit for the filter definition alone.Output
Get Country
Get Country
Fetch Blog
Fetch Blog
Fetch Blog Category
Fetch Blog Category
Fetch Blog Post
Fetch Blog Post
CLICKFUNNELS_GET_BLOG_POSTFetch Blog Post. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.Input Parameters
expand[]=markup to include the PML markup for the post’s visual content. Markup is opt-in on every endpoint (show, list, create, update) because PML serialization runs per post. See the Expanding guide for available fields and examples.Output
Fetch Blog Tag
Fetch Blog Tag
Fetch Community
Fetch Community
Fetch Ban
Fetch Ban
Fetch Ban Export Action
Fetch Ban Export Action
Fetch Ban Unban Action
Fetch Ban Unban Action
Fetch Membership
Fetch Membership
Fetch Membership Add-To-Group Action
Fetch Membership Add-To-Group Action
Fetch Membership Ban Action
Fetch Membership Ban Action
Fetch Membership Export Action
Fetch Membership Export Action
Fetch Membership Remove-From-Group Action
Fetch Membership Remove-From-Group Action
Fetch Space Group
Fetch Space Group
Fetch Space
Fetch Space
Fetch Post
Fetch Post
Fetch Comment
Fetch Comment
Fetch Video Embed
Fetch Video Embed
Get a Contact Filter
Get a Contact Filter
CLICKFUNNELS_GET_CONTACT_FILTERGet a Contact Filter. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
true for ids only; omit for the filter definition alone.Output
Fetch Contact
Fetch Contact
CLICKFUNNELS_GET_CONTACTSFetch Contact. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.Output
Fetch Applied Tag
Fetch Applied Tag
Get contact billing address
Get contact billing address
Fetch Enroll Action
Fetch Enroll Action
Fetch Contact Event
Fetch Contact Event
Fetch Contact Activity Note
Fetch Contact Activity Note
Fetch Export Action
Fetch Export Action
Fetch Run Workflow Action
Fetch Run Workflow Action
Fetch Contact Subscription Change
Fetch Contact Subscription Change
Fetch Tag Action
Fetch Tag Action
Fetch Tag
Fetch Tag
Fetch Unsubscribe Action
Fetch Unsubscribe Action
Fetch Contact Topic Opt-out
Fetch Contact Topic Opt-out
Fetch Course
Fetch Course
Fetch Enrollment
Fetch Enrollment
Fetch Lesson Completion
Fetch Lesson Completion
Fetch Lesson
Fetch Lesson
Fetch Section
Fetch Section
Fetch Publish Action
Fetch Publish Action
Fetch My User
Fetch My User
Fetch Discount
Fetch Discount
Fetch Domain
Fetch Domain
Fetch Download
Fetch Download
Get Email Address
Get Email Address
Fetch Email Broadcast
Fetch Email Broadcast
Fetch Send Action
Fetch Send Action
Fetch Email Broadcast Stats
Fetch Email Broadcast Stats
Get Email Domain
Get Email Domain
Get Email Settings
Get Email Settings
Fetch Email Template
Fetch Email Template
Fetch Email Topic
Fetch Email Topic
Fetch Form
Fetch Form
Fetch Field
Fetch Field
Fetch Field Set
Fetch Field Set
Fetch Option
Fetch Option
Fetch Submission
Fetch Submission
Fetch Answer
Fetch Answer
Fetch Form Submission
Fetch Form Submission
Fetch Fulfillment
Fetch Fulfillment
Fetch Location
Fetch Location
Fetch Conditional Split Step
Fetch Conditional Split Step
Fetch Funnel
Fetch Funnel
CLICKFUNNELS_GET_FUNNELSFetch Funnel. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.Output
Fetch Funnel Clone Action
Fetch Funnel Clone Action
Fetch Split Test Step
Fetch Split Test Step
Fetch Tag
Fetch Tag
Fetch Funnel Stats
Fetch Funnel Stats
CLICKFUNNELS_GET_FUNNEL_STATSFetch Funnel Stats. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.Input Parameters
expand[]=steps to include per-step statistics. When expand[]=steps is set, the response contains a steps array with detailed metrics for each funnel step. When omitted, the response contains a page_public_ids array instead. See the expanded steps response in the Stats Skill for both response shapes.+ as %2B, since an unencoded + arrives as a space). Defaults to the current time. Values in the future are automatically clamped to now.+ as %2B, since an unencoded + arrives as a space). Defaults to 30 days before timerange_end. If the window between start and end exceeds 90 days, start is automatically clamped to 90 days before end. If start is after end, the window resets to the default 30 days ending at timerange_end. See Timerange parameters (both endpoints) in the Stats Skill for the clamping rules and how to cover longer windows.Output
Fetch Funnel Structure
Fetch Funnel Structure
Fetch Image
Fetch Image
Fetch Order
Fetch Order
Fetch Applied Tag
Fetch Applied Tag
Fetch Invoice
Fetch Invoice
Fetch Tag
Fetch Tag
Fetch Transaction
Fetch Transaction
Fetch Custom HTML Page Body
Fetch Custom HTML Page Body
Fetch Page
Fetch Page
CLICKFUNNELS_GET_PAGESFetch Page. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields (e.g., expand[]=head_code&expand[]=footer_code&expand[]=custom_css&expand[]=markup). Markup is opt-in on every endpoint (show, list, create, update) because PML serialization runs per page. custom_css is available on internal pages only. See the Expanding guide for available fields and examples. Read a page’s existing markup with expand[]=markup before editing it: see Reading Current Markup in the Pages Skill.Output
Fetch Page Stats
Fetch Page Stats
CLICKFUNNELS_GET_PAGE_STATSFetch Page Stats. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.Input Parameters
+ as %2B, since an unencoded + arrives as a space). Defaults to the current time. Values in the future are automatically clamped to now.+ as %2B, since an unencoded + arrives as a space). Defaults to 30 days before timerange_end. If the window between start and end exceeds 90 days, start is automatically clamped to 90 days before end. If start is after end, the window resets to the default 30 days ending at timerange_end. See Timerange parameters (both endpoints) in the Stats Skill for the clamping rules and how to cover longer windows.Output
Fetch Product
Fetch Product
Fetch Collection
Fetch Collection
Fetch Price
Fetch Price
Fetch Tag
Fetch Tag
Fetch Variant
Fetch Variant
Fetch Refine Filter
Fetch Refine Filter
CLICKFUNNELS_GET_REFINE_FILTERFetch Refine Filter. ClickFunnels applies Contacts read access to this endpoint regardless of the saved filter class; Contacts write or coarse read/write also authorizes it.Input Parameters
true for ids only; omit for the filter definition alone.Output
Fetch Restock
Fetch Restock
Fetch Opportunity
Fetch Opportunity
Fetch Note
Fetch Note
Fetch Pipeline
Fetch Pipeline
Fetch Stage
Fetch Stage
Fetch Segment
Fetch Segment
CLICKFUNNELS_GET_SEGMENTSFetch Segment. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Output
Get shipping addresses
Get shipping addresses
Fetch Location Group
Fetch Location Group
Fetch Package
Fetch Package
Fetch Profile
Fetch Profile
Fetch Rate
Fetch Rate
Fetch Name
Fetch Name
Fetch Zone
Fetch Zone
Fetch Site
Fetch Site
CLICKFUNNELS_GET_SITEFetch Site. API access tokens need sites:read or sites:write permission; the coarse read or write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields (e.g., expand[]=head_code&expand[]=footer_code). See the Expanding guide for available fields and examples.Output
Fetch Store
Fetch Store
Fetch Team
Fetch Team
Fetch Theme
Fetch Theme
Check Short Link Availability
Check Short Link Availability
CLICKFUNNELS_GET_URL_REDIRECT_AVAILABILITYCheck Short Link Availability. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Output
Fetch Short Link
Fetch Short Link
Fetch Short Link Stats
Fetch Short Link Stats
Fetch User
Fetch User
Fetch Incoming External Purchase Endpoint
Fetch Incoming External Purchase Endpoint
Fetch Incoming External Purchase Event
Fetch Incoming External Purchase Event
Fetch Incoming External Purchase Product Mapping
Fetch Incoming External Purchase Product Mapping
Fetch Endpoint
Fetch Endpoint
Fetch Event
Fetch Event
Fetch Workflow
Fetch Workflow
Fetch Run
Fetch Run
Fetch Step
Fetch Step
Fetch Workflow Step Stats
Fetch Workflow Step Stats
CLICKFUNNELS_GET_WORKFLOW_STEP_STATSFetch Workflow Step Stats. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.Input Parameters
+ as %2B, since an unencoded + arrives as a space). Defaults to the current time. Values in the future are automatically clamped to now.+ as %2B, since an unencoded + arrives as a space). Defaults to 30 days before timerange_end. If the window between start and end exceeds 90 days, start is automatically clamped to 90 days before end. If start is after end, the window resets to the default 30 days ending at timerange_end. See Timerange parameters (both endpoints) in the Stats Skill for the clamping rules and how to cover longer windows.Output
Fetch Workflow Structure
Fetch Workflow Structure
Fetch Trigger
Fetch Trigger
Fetch Workspace
Fetch Workspace
Fetch Workspace Stats
Fetch Workspace Stats
CLICKFUNNELS_GET_WORKSPACE_STATSFetch Workspace Stats. Because one call can select Contacts, Store, or Forms records, API access tokens need coarse read or write permission.Input Parameters
unavailable instead when it cannot finish in time. Not available for every resource.count_capped_at in the response.contact: id, email_address, is_active, tag_ids; order: id, contact_id, order_type, billing_status, service_status, live_mode; form_submission: id, page_id, contact_id - plus created_at_after (inclusive) and created_at_before (exclusive, both ISO 8601 only; send an offset’s + as %2B) on every resource, and funnel_id and product_id on order. Every id filter takes a numeric id or a public_id; one that is not this workspace’s is a 422. Comma-separated values match any of them.stable_id token, applied to the set before computing. Same token format the resource’s index accepts; for contacts it can come from POST /workspaces/{workspace_id}/contacts/filters. Pass it exactly as returned. Not accepted for form_submission (422).created_at in the matching set. Exact; listed in unavailable instead when it cannot finish in time.id or public_id of a saved Refine filter in this workspace, applied to the set before computing. Must match the resource’s filter type. Not accepted for form_submission (422).Output
List Countries
List Countries
List Country Regions
List Country Regions
List Scheduled Events
List Scheduled Events
CLICKFUNNELS_LIST_APPOINTMENTS_SCHEDULED_EVENTSList Scheduled Events. Returns one page and a next cursor when more records are available. API access tokens need appointments:read or appointments:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Blogs
List Blogs
CLICKFUNNELS_LIST_BLOGSList Blogs. Returns one page and a next cursor when more records are available. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Blog Categories
List Blog Categories
CLICKFUNNELS_LIST_BLOGS_CATEGORIESList Blog Categories. Returns one page and a next cursor when more records are available. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Blog Posts
List Blog Posts
CLICKFUNNELS_LIST_BLOGS_POSTSList Blog Posts. Returns one page and a next cursor when more records are available. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.Input Parameters
expand[]=markup to include the PML markup for the post’s visual content. Markup is opt-in on every endpoint (show, list, create, update) because PML serialization runs per post. See the Expanding guide for available fields and examples.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Communities
List Communities
CLICKFUNNELS_LIST_COMMUNITIESList Communities. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Bans
List Bans
CLICKFUNNELS_LIST_COMMUNITIES_BANSList Bans. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Ban Export Actions
List Ban Export Actions
CLICKFUNNELS_LIST_COMMUNITIES_BANS_EXPORT_ACTIONSList Ban Export Actions. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Memberships
List Memberships
CLICKFUNNELS_LIST_COMMUNITIES_MEMBERSHIPSList Memberships. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Membership Export Actions
List Membership Export Actions
CLICKFUNNELS_LIST_COMMUNITIES_MEMBERSHIPS_EXPORT_ACTIONSList Membership Export Actions. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Space Groups
List Space Groups
CLICKFUNNELS_LIST_COMMUNITIES_SPACE_GROUPSList Space Groups. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Spaces
List Spaces
CLICKFUNNELS_LIST_COMMUNITIES_SPACESList Spaces. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Posts
List Posts
CLICKFUNNELS_LIST_COMMUNITIES_SPACES_POSTSList Posts. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Comments
List Comments
CLICKFUNNELS_LIST_COMMUNITIES_SPACES_POSTS_COMMENTSList Comments. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Comment Likes
List Comment Likes
CLICKFUNNELS_LIST_COMMUNITIES_SPACES_POSTS_COMMENTS_LIKESList Comment Likes. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Post Likes
List Post Likes
CLICKFUNNELS_LIST_COMMUNITIES_SPACES_POSTS_LIKESList Post Likes. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Video Embeds
List Video Embeds
CLICKFUNNELS_LIST_COMMUNITIES_SPACES_POSTS_VIDEO_EMBEDSList Video Embeds. Returns one page and a next cursor when more records are available. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Contacts
List Contacts
CLICKFUNNELS_LIST_CONTACTSList Contacts. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.stable_id token in the gzip+base64 full-state format shared by the contacts/filters API and server-rendered filter UI. Returned by POST /api/v2/workspaces/{workspace_id}/contacts/filters in the stable_id field. Treat it as opaque and let the HTTP client encode the complete query value. With curl, use -G --data-urlencode "stable_id=$STABLE_ID"; do not decode it or interpolate it into a raw URL. Applies the criteria to results, composed (AND) with any filter[…] params. Returns 422 if invalid, not a contact filter (a segment’s ContactsSegmentsFilter counts), or grouped with mixed and/or semantics. Flat filters and grouped filters using one conjunction, including tokens copied from the filtered Contacts UI, are supported. If both stored_filter_id and stable_id are supplied, stable_id takes precedence.id (integer) or public_id (string) of a saved Refine::StoredFilter scoped to this workspace. Returned by POST /api/v2/workspaces/{workspace_id}/contacts/filters (with save: true), by the RefineFilter endpoints, or as a segment’s filter_id. Applies the saved filter’s criteria to the results, composed (AND) with any filter[…] params. Returns 422 if the filter is unknown, invalid, or belongs to a different workspace. When both stored_filter_id and stable_id are supplied, stable_id takes precedence.Output
List Enroll Actions
List Enroll Actions
CLICKFUNNELS_LIST_CONTACTS_ENROLL_ACTIONSList Enroll Actions. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Contact Events
List Contact Events
CLICKFUNNELS_LIST_CONTACTS_EVENTSList Contact Events. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Contact Activity Notes
List Contact Activity Notes
CLICKFUNNELS_LIST_CONTACTS_EVENTS_NOTESList Contact Activity Notes. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Export Actions
List Export Actions
CLICKFUNNELS_LIST_CONTACTS_EXPORT_ACTIONSList Export Actions. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Run Workflow Actions
List Run Workflow Actions
CLICKFUNNELS_LIST_CONTACTS_RUN_WORKFLOW_ACTIONSList Run Workflow Actions. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Contact Subscription Changes
List Contact Subscription Changes
CLICKFUNNELS_LIST_CONTACTS_SUBSCRIPTION_CHANGESList Contact Subscription Changes. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Tag Actions
List Tag Actions
CLICKFUNNELS_LIST_CONTACTS_TAG_ACTIONSList Tag Actions. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Unsubscribe Actions
List Unsubscribe Actions
CLICKFUNNELS_LIST_CONTACTS_UNSUBSCRIBE_ACTIONSList Unsubscribe Actions. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Contact Topic Opt-outs
List Contact Topic Opt-outs
CLICKFUNNELS_LIST_CONTACTS_UNSUBSCRIBED_TOPICSList Contact Topic Opt-outs. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Courses
List Courses
CLICKFUNNELS_LIST_COURSESList Courses. Returns one page and a next cursor when more records are available. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Enrollments
List Enrollments
CLICKFUNNELS_LIST_COURSES_ENROLLMENTSList Enrollments. Returns one page and a next cursor when more records are available. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Lesson Completions
List Lesson Completions
CLICKFUNNELS_LIST_COURSES_LESSON_COMPLETIONSList Lesson Completions. Returns one page and a next cursor when more records are available. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Lessons
List Lessons
CLICKFUNNELS_LIST_COURSES_LESSONSList Lessons. Returns one page and a next cursor when more records are available. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Sections
List Sections
CLICKFUNNELS_LIST_COURSES_SECTIONSList Sections. Returns one page and a next cursor when more records are available. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Publish Actions
List Publish Actions
CLICKFUNNELS_LIST_COURSES_SECTIONS_PUBLISH_ACTIONSList Publish Actions. Returns one page and a next cursor when more records are available. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Discounts
List Discounts
CLICKFUNNELS_LIST_DISCOUNTSList Discounts. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Domains
List Domains
CLICKFUNNELS_LIST_DOMAINSList Domains. Returns one page and a next cursor when more records are available. API access tokens need sites:read or sites:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Downloads
List Downloads
CLICKFUNNELS_LIST_DOWNLOADSList Downloads. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Email Addresses
List Email Addresses
CLICKFUNNELS_LIST_EMAILS_ADDRESSESList Email Addresses. Returns one page and a next cursor when more records are available. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[email_address]=value&filter[verified]=true. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Email Broadcasts
List Email Broadcasts
CLICKFUNNELS_LIST_EMAILS_BROADCASTSList Email Broadcasts. Returns one page and a next cursor when more records are available. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Send Actions
List Send Actions
CLICKFUNNELS_LIST_EMAILS_BROADCASTS_SEND_ACTIONSList send actions for a specified broadcast, returning one page and a next cursor when more records are available. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Email Domains
List Email Domains
CLICKFUNNELS_LIST_EMAILS_DOMAINSList Email Domains. Returns one page and a next cursor when more records are available. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Email Templates
List Email Templates
CLICKFUNNELS_LIST_EMAILS_TEMPLATESList Email Templates. Returns one page and a next cursor when more records are available. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Email Topics
List Email Topics
CLICKFUNNELS_LIST_EMAILS_TOPICSList Email Topics. Returns one page and a next cursor when more records are available. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Forms
List Forms
CLICKFUNNELS_LIST_FORMSList Forms. Returns one page and a next cursor when more records are available. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Fields
List Fields
CLICKFUNNELS_LIST_FORMS_FIELDSList Fields. Returns one page and a next cursor when more records are available. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Field Sets
List Field Sets
CLICKFUNNELS_LIST_FORMS_FIELD_SETSList Field Sets. Returns one page and a next cursor when more records are available. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Options
List Options
CLICKFUNNELS_LIST_FORMS_FIELDS_OPTIONSList Options. Returns one page and a next cursor when more records are available. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Submissions
List Submissions
CLICKFUNNELS_LIST_FORMS_SUBMISSIONSList Submissions. Returns one page and a next cursor when more records are available. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Answers
List Answers
CLICKFUNNELS_LIST_FORMS_SUBMISSIONS_ANSWERSList Answers. Returns one page and a next cursor when more records are available. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Form Submissions
List Form Submissions
CLICKFUNNELS_LIST_FORM_SUBMISSIONSList Form Submissions. Returns one page and a next cursor when more records are available. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Fulfillments
List Fulfillments
CLICKFUNNELS_LIST_FULFILLMENTSList Fulfillments. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Locations
List Locations
CLICKFUNNELS_LIST_FULFILLMENTS_LOCATIONSList Locations. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Conditional Split Steps
List Conditional Split Steps
List Funnels
List Funnels
CLICKFUNNELS_LIST_FUNNELSList Funnels. Returns one page and a next cursor when more records are available. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Funnel Clone Actions
List Funnel Clone Actions
CLICKFUNNELS_LIST_FUNNELS_CLONE_ACTIONSList Funnel Clone Actions. Returns one page and a next cursor when more records are available. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Split Test Steps
List Split Test Steps
List Images
List Images
CLICKFUNNELS_LIST_IMAGESList Images. Returns one page and a next cursor when more records are available. API access tokens need media:read or media:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Orders
List Orders
CLICKFUNNELS_LIST_ORDERSList Orders. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.stable_id token copied from a filtered ClickFunnels Orders page. Send it as an encoded query parameter; do not decode it or concatenate its raw value into a URL. Applies the order-filter criteria to results, composed (AND) with any filter[...] params. Returns 422 if malformed, not an order filter, mixing and/or across conditions, or referencing records outside this workspace. Flat filters and grouped filters using one conjunction, including tokens copied from the filtered Orders UI, are supported. Mixing conjunctions is rejected even without grouping because a flat filter cannot express it. If both selectors are supplied, stable_id takes precedence. See Applying existing order filters in the Refine Filters Skill for where to copy and send the token.id (integer) or public_id (string) of a saved order filter scoped to this workspace. Existing saved filters can be discovered with GET /api/v2/workspaces/{workspace_id}/refine_filters; choose an entry whose filter_class is OrdersFilter. Applies the saved filter’s criteria to the results, composed (AND) with any filter[...] params. Returns 422 if the filter is unknown, invalid, belongs to a different workspace, or is not an order filter. When both stored_filter_id and stable_id are supplied, stable_id takes precedence.Output
List Invoices
List Invoices
CLICKFUNNELS_LIST_ORDERS_INVOICESList Invoices. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Transactions
List Transactions
CLICKFUNNELS_LIST_ORDERS_TRANSACTIONSList Transactions. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Pages
List Pages
CLICKFUNNELS_LIST_PAGESList Pages. Returns one page and a next cursor when more records are available. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields (e.g., expand[]=head_code&expand[]=footer_code&expand[]=custom_css&expand[]=markup). Markup is opt-in on every endpoint (show, list, create, update) because PML serialization runs per page. custom_css is available on internal pages only. See the Expanding guide for available fields and examples. Read a page’s existing markup with expand[]=markup before editing it: see Reading Current Markup in the Pages Skill.api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Products
List Products
CLICKFUNNELS_LIST_PRODUCTSList Products. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Collections
List Collections
CLICKFUNNELS_LIST_PRODUCTS_COLLECTIONSList Collections. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Prices
List Prices
CLICKFUNNELS_LIST_PRODUCTS_PRICESList Prices. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Upgrade/Downgrade Options
List Upgrade/Downgrade Options
CLICKFUNNELS_LIST_PRODUCTS_PRICES_CHANGE_OPTIONSList Upgrade/Downgrade Options. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
public_id string.Output
List Variants
List Variants
CLICKFUNNELS_LIST_PRODUCTS_VARIANTSList Variants. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Restocks
List Restocks
CLICKFUNNELS_LIST_RESTOCKSList Restocks. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Opportunities
List Opportunities
CLICKFUNNELS_LIST_SALES_OPPORTUNITIESList Opportunities. Returns one page and a next cursor when more records are available. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Notes
List Notes
CLICKFUNNELS_LIST_SALES_OPPORTUNITIES_NOTESList Notes. Returns one page and a next cursor when more records are available. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Pipelines
List Pipelines
CLICKFUNNELS_LIST_SALES_PIPELINESList Pipelines. Returns one page and a next cursor when more records are available. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Stages
List Stages
CLICKFUNNELS_LIST_SALES_PIPELINES_STAGESList Stages. Returns one page and a next cursor when more records are available. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Segments
List Segments
CLICKFUNNELS_LIST_SEGMENTSList Segments. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Output
List shipping addresses
List shipping addresses
CLICKFUNNELS_LIST_SHIPPING_ADDRESSESList shipping addresses. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Location Groups
List Location Groups
CLICKFUNNELS_LIST_SHIPPING_LOCATION_GROUPSList Location Groups. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Packages
List Packages
CLICKFUNNELS_LIST_SHIPPING_PACKAGESList Packages. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Profiles
List Profiles
CLICKFUNNELS_LIST_SHIPPING_PROFILESList Profiles. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Rates
List Rates
CLICKFUNNELS_LIST_SHIPPING_RATESList Rates. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Names
List Names
CLICKFUNNELS_LIST_SHIPPING_RATES_NAMESList Names. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Zones
List Zones
CLICKFUNNELS_LIST_SHIPPING_ZONESList Zones. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Stores
List Stores
CLICKFUNNELS_LIST_STORESList Stores. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Styles
List Styles
CLICKFUNNELS_LIST_STYLESList Styles. Returns one page and a next cursor when more records are available. API access tokens need sites:read or sites:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Teams
List Teams
CLICKFUNNELS_LIST_TEAMSList Teams. Returns one page and a next cursor when more records are available. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Themes
List Themes
CLICKFUNNELS_LIST_THEMESList Themes. Returns one page and a next cursor when more records are available. API access tokens need sites:read or sites:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Short Links
List Short Links
CLICKFUNNELS_LIST_URL_REDIRECTSList Short Links. Returns one page and a next cursor when more records are available. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Users
List Users
CLICKFUNNELS_LIST_USERSList Users. Returns one page and a next cursor when more records are available. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Incoming External Purchase Endpoints
List Incoming External Purchase Endpoints
CLICKFUNNELS_LIST_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_ENDPOINTSList Incoming External Purchase Endpoints. Returns one page and a next cursor when more records are available. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.Input Parameters
id, provider or live_mode, like this: ?filter[provider]=whop&filter[live_mode]=true. All about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Incoming External Purchase Events
List Incoming External Purchase Events
CLICKFUNNELS_LIST_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_EVENTSList Incoming External Purchase Events. Returns one page and a next cursor when more records are available. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.Input Parameters
id, event_type or processing_status, like this: ?filter[event_type]=payment.succeeded&filter[processing_status]=success. All about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Incoming External Purchase Product Mappings
List Incoming External Purchase Product Mappings
CLICKFUNNELS_LIST_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_PRODUCT_MAPPINGSList Incoming External Purchase Product Mappings. Returns one page and a next cursor when more records are available. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Endpoints
List Endpoints
CLICKFUNNELS_LIST_WEBHOOKS_OUTGOING_ENDPOINTSList Endpoints. Returns one page and a next cursor when more records are available. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Events
List Events
CLICKFUNNELS_LIST_WEBHOOKS_OUTGOING_EVENTSList Events. Returns one page and a next cursor when more records are available. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Event Types
List Event Types
List Runs
List Runs
CLICKFUNNELS_LIST_WORKFLOW_RUNSList Runs. Returns one page and a next cursor when more records are available. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.Input Parameters
contact_id (integer id or obfuscated public_id of the contact) and/or status (active, paused, completed, or canceled). An invalid status value returns 422.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Workflows
List Workflows
CLICKFUNNELS_LIST_WORKFLOWSList Workflows. Returns one page and a next cursor when more records are available. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Steps
List Steps
CLICKFUNNELS_LIST_WORKFLOW_STEPSList Steps. Returns one page and a next cursor when more records are available. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Triggers
List Triggers
CLICKFUNNELS_LIST_WORKFLOW_TRIGGERSList Triggers. Returns one page and a next cursor when more records are available. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Workspace Contact Topic Opt-outs
List Workspace Contact Topic Opt-outs
CLICKFUNNELS_LIST_WORKSPACE_CONTACTS_UNSUBSCRIBED_TOPICSList Workspace Contact Topic Opt-outs. Returns one page and a next cursor when more records are available. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Workspace Invoices
List Workspace Invoices
CLICKFUNNELS_LIST_WORKSPACE_ORDERS_INVOICESList Workspace Invoices. Returns one page and a next cursor when more records are available. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.Input Parameters
api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.Output
List Refine Filters
List Refine Filters
CLICKFUNNELS_LIST_WORKSPACE_REFINE_FILTERSList Refine Filters. By default, returns the complete saved-filter registry without pagination. Provide cursor=0 or per_page to opt into bounded paging; paged responses include a next cursor when more records are available. ClickFunnels applies Contacts read access to this endpoint regardless of the saved filter classes returned; Contacts write or coarse read/write also authorizes it.Input Parameters
0 to opt into bounded paging from the beginning, or pass the continuation cursor returned as next_cursor by a previous paged call. Omit this and per_page to return the complete saved-filter registry without pagination.api/v2/resources?filter[name]=value. Check our Filtering guide for examples and all about filtering here.cursor to return the complete saved-filter registry; providing either enters paged mode, which defaults to 20 records and caps the page size at 100. Zero, a negative, or a non-integer value is a 422. More in our guides.Output
List Workspaces
List Workspaces
CLICKFUNNELS_LIST_WORKSPACESList Workspaces. Returns one page and a next cursor when more records are available. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.Input Parameters
Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.id; updated_at and name are also supported.Output
Change Variant/Price
Change Variant/Price
CLICKFUNNELS_PERFORM_ORDERS_LINE_ITEMS_CHANGEChange Variant/Price. This can trigger an irreversible external effect. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
true, false, "true", "false", "1", "0", 1, or 0. When omitted, the in-app default is used: upgrades are prorated and applied immediately; downgrades are not prorated and take effect at the end of the current billing cycle. Forced to false for physical line items regardless of the value sent. Any other value returns 422.public_id string returned by line-item endpoints.null, or an empty string), the in-app default is used: upgrades take effect now, downgrades at the next renewal. Any other value (e.g. end_of_period or a literal timestamp) returns 422.public_id string returned by the discovery endpoint. The target variant is derived from the price’s variant association.Output
Pin Post
Pin Post
Preview Variant/Price Change
Preview Variant/Price Change
CLICKFUNNELS_PREVIEW_ORDERS_LINE_ITEMS_CHANGEPreview Variant/Price Change. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
true, false, "true", "false", "1", "0", 1, or 0. When omitted, the in-app default is used: upgrades are prorated and applied immediately; downgrades are not prorated and take effect at the end of the current billing cycle. Forced to false for physical line items regardless of the value sent. Any other value returns 422.public_id string returned by line-item endpoints.null, or an empty string), the in-app default is used: upgrades take effect now, downgrades at the next renewal. Any other value (e.g. end_of_period or a literal timestamp) returns 422.public_id string returned by the discovery endpoint. The target variant is derived from the price’s variant association.Output
Publish Course
Publish Course
CLICKFUNNELS_PUBLISH_COURSEPublish Course. This can trigger an irreversible external effect. API access tokens need courses:write permission; the coarse write permission also authorizes this action.Input Parameters
true, sets the requested publish timestamp on the course, every eligible unpublished non-root section, and all unpublished or scheduled lessons before returning the response. Drip and blocked section gates remain in effect. Section publish actions may continue follow-up processing asynchronously. Use this for a one-step publish of a new course. Defaults to false.Output
Publish Lesson
Publish Lesson
CLICKFUNNELS_PUBLISH_COURSES_LESSONSPublish Lesson. This can trigger an irreversible external effect. API access tokens need courses:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Publish Section
Publish Section
CLICKFUNNELS_PUBLISH_COURSES_SECTIONSPublish Section. This can trigger an irreversible external effect. API access tokens need courses:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Refund Transaction
Refund Transaction
CLICKFUNNELS_REFUND_ORDERS_TRANSACTIONSRefund Transaction. This can trigger an irreversible external effect. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
requested_by_customer. Stripe orders accept only duplicate, fraudulent, or requested_by_customer; any other value returns 422 listing the accepted set. Payments AI (Rebilly) orders treat this as a free-text description that is recorded on the refund and the order timeline.false or omitted. Sending true returns 422 rather than silently refunding the full charge. An amount field is rejected the same way - honoring it would be a partial refund, and ignoring it would refund more than you asked for.Output
Reorder Fields
Reorder Fields
Set Default Theme
Set Default Theme
Restore an archived Funnel
Restore an archived Funnel
CLICKFUNNELS_UNARCHIVE_FUNNELSRestore an archived Funnel. API access tokens need funnels:write (or coarse write) permission; restoring archived products also needs store:write (or coarse write).Input Parameters
expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.Output
Unarchive a Product
Unarchive a Product
Unpin Post
Unpin Post
Update Blog
Update Blog
Update Blog Post
Update Blog Post
CLICKFUNNELS_UPDATE_BLOG_POSTUpdate Blog Post. API access tokens need blog:write permission; the coarse write permission also authorizes this action.Input Parameters
markup to leave the body untouched. Validation occurs before any database write; invalid or mid-construct/truncated markup returns 400 without creating or updating the post. Re-send the complete document, not only the missing tail. Raw HTML is not PML; normalize and wrap it for PML. See the Page Markup Skill for the DSL, approval guardrail, and normalization rules.expand[]=markup to include the PML markup for the post’s visual content. Markup is opt-in on every endpoint (show, list, create, update) because PML serialization runs per post. See the Expanding guide for available fields and examples.draft, public, members_only, or scheduled. See Two gotchas worth knowing in the Blogs Skill.scheduled. See Publish separately in the Import External Blog Post Skill.Output
Update Community
Update Community
Update Membership
Update Membership
CLICKFUNNELS_UPDATE_COMMUNITIES_MEMBERSHIPSUpdate Membership. API access tokens need community:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Space Group
Update Space Group
Update Space
Update Space
Update Post
Update Post
Update Comment
Update Comment
Update Contact
Update Contact
CLICKFUNNELS_UPDATE_CONTACTSUpdate Contact. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.snake_case (For example, ‘Favorite Food! 🥑’ will be converted to ‘favorite_food’). Empty keys will trigger a bad request response. Also, non-object inputs for custom_attributes (e.g. an array or string), it will be ignored. Keys that are default properties on the Contact resource or variations of it will result in an error. E.g., ‘first_name’, ‘First Name’, etc. are not valid inputs.Output
Update contact billing address
Update contact billing address
Update Contact Activity Note
Update Contact Activity Note
CLICKFUNNELS_UPDATE_CONTACTS_EVENTS_NOTESUpdate Contact Activity Note. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Tag
Update Tag
Update Course
Update Course
Update Enrollment
Update Enrollment
Update Lesson
Update Lesson
CLICKFUNNELS_UPDATE_COURSES_LESSONSUpdate Lesson. API access tokens need courses:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Section
Update Section
Update Discount
Update Discount
CLICKFUNNELS_UPDATE_DISCOUNTSUpdate Discount. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
apply_until, accepted on update only (sending it on create returns 422). true expires the discount immediately by setting apply_until to now; false lifts an expiry by clearing apply_until, the same as Remove Expiration in the app. It ends a discount that has not started yet (scheduled: true) as well, discarding the future apply_from, since nothing can end before it starts. A discount that has been redeemed cannot be un-expired and returns 422. Sending the state the discount is already in changes nothing and returns 200 without moving apply_until, so echoing a serialized discount back in a routine update cannot clear a scheduled end date - to remove a future end date, PATCH apply_until to null instead. Only true and false are accepted; any other value returns 422 rather than being read as “expire it”.apply_from; a past date returns 422. To expire a live discount now, use expired: true instead.code is a redeemable coupon code. automatic and sale are deprecated.50 on a usd discount means $50.Output
Update Email Address
Update Email Address
CLICKFUNNELS_UPDATE_EMAILS_ADDRESSESUpdate Email Address. API access tokens need emails:write permission; the coarse write permission also authorizes this action.Input Parameters
clickfunnelsmail.com). This is not how you use your own domain: putting a custom name here neither provisions nor authenticates it, and the request is rejected with 422 unless emails_domain_id is also given. To send from your own domain, provision it first and pass its numeric id as emails_domain_id, which is what the address is then created on.id (not public_id) of a custom sending domain belonging to this workspace. Use the Email Domains endpoints to provision it and wait until that domain is ready to send before sending from the resulting address.Output
Update Email Broadcast
Update Email Broadcast
CLICKFUNNELS_UPDATE_EMAILS_BROADCASTUpdate Email Broadcast. API access tokens need emails:write permission; the coarse write permission also authorizes this action.Input Parameters
id or the public id (string) of a saved contact filter (Refine::StoredFilter) in this workspace, or a serialized contact filter. The supplied filter is copied onto the broadcast — the broadcast points at its own copy, so later edits to (or deletion of) the saved filter never change this broadcast’s audience. Saved contact filters can be created/listed via the Refine Filters Skill. See Applying filters to email broadcasts."true" return 422.false to deliver the whole audience in one go. Above 5,000 recipients Smart Sending is mandatory: sending false is accepted and may be stored as true. The send batches at that size regardless of the stored value.smart_sending_units the delivery window spans, for example 2 with hour. Must be between 0.5 and 100, and must be sent together with smart_sending_unit. Send both as null to go back to sizing the window from the audience.smart_sending_time. Send both as null to go back to sizing the window from the audience.Output
Update Email Settings
Update Email Settings
CLICKFUNNELS_UPDATE_EMAILS_SETTINGSUpdate Email Settings. API access tokens need emails:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Email Template
Update Email Template
Update Email Topic
Update Email Topic
Update Form
Update Form
Update Field
Update Field
Update Field Set
Update Field Set
Update Option
Update Option
Update Submission
Update Submission
Update Answer
Update Answer
Update Fulfillment
Update Fulfillment
Update Location
Update Location
CLICKFUNNELS_UPDATE_FULFILLMENTS_LOCATIONSUpdate a fulfillment location; archived defaults to false and is sent unless explicitly set to null. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Conditional Split Step
Update Conditional Split Step
Update Funnel
Update Funnel
CLICKFUNNELS_UPDATE_FUNNELSUpdate Funnel. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.Output
Update Split Test Step
Update Split Test Step
Update Tag
Update Tag
Update Image
Update Image
Update Order
Update Order
CLICKFUNNELS_UPDATE_ORDERSUpdate Order. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
pending, active, or paused state using an absolute RFC 3339 timestamp within the next two years. This moves the next billing attempt without changing the amount or prorating it. A renewal cannot precede a future trial end. Send both fields with the same timestamp to end the trial and bill then. To renew later, update trial_end_at first, re-read the order until it shows the effective new trial end, then update renewal_at.in_trial: true; Payments AI also accepts trial_end_at as the equal companion to a legal renewal_at move while the stored trial end is still in the future. The timestamp must include a date, time, and UTC offset and be within the next two years. Moving the trial end also moves the first charge. Send a timestamp a few seconds ahead to end the trial now.customer_service, low_quality, missing_features, other, switched_service, too_complex, too_expensive, unusedpending, paid, unpaid, voided and refunded.pending or completed. For external subscription orders possible statuses are pending, active, churned, canceled, completed, paused.Output
Update External Invoice
Update External Invoice
CLICKFUNNELS_UPDATE_ORDERS_INVOICESUpdate External Invoice. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
unpaid, paid, voided, refunded, disputed, past-due. When changing status to paid, you must also provide paid_at. A change in status will update the billing_status of the parent order. If a one-time order’s invoice status is changed to paid, the order’s service_status will also flip to completed.id will be processed; new line items (without id) are ignored during updates.Output
Update Tag
Update Tag
Update Page
Update Page
CLICKFUNNELS_UPDATE_PAGESUpdate Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields (e.g., expand[]=head_code&expand[]=footer_code&expand[]=custom_css&expand[]=markup). Markup is opt-in on every endpoint (show, list, create, update) because PML serialization runs per page. custom_css is available on internal pages only. See the Expanding guide for available fields and examples. Read a page’s existing markup with expand[]=markup before editing it: see Reading Current Markup in the Pages Skill.show_page_step_id is supported — swap the page onto an existing show page step.<customhtml> body, or element) returns 400 and leaves the page unchanged; re-send the complete document. For tracking pixels or custom code, use head_code/footer_code, not the body. See the Page Markup Skill for the DSL, approval guardrail, and common validation errors.sitemap.xml. Internal and custom HTML pages — returns 422 on external pages.0 moves it to the first position. The page must belong to exactly one funnel step; pages with zero or multiple funnel steps return 422. Out-of-bounds values return 422. Ignored when funnel.show_page_step_id is also provided — the swap target’s position takes precedence.GET /pages/{id}/custom_html./my-page). Internal and custom HTML pages — returns 422 on external pages. For a custom HTML page that is a funnel step, this moves the STEP’s path (the customer-facing URL); when standalone, the page’s own path. Returns 422 when the page backs more than one funnel step — the target would be ambiguous.show_page_step.product_ids or show_page_step.bumps for a page that isn’t linked to a funnel returns 400. Shared by both internal and external pages.Output
Update Product
Update Product
CLICKFUNNELS_UPDATE_PRODUCTSUpdate Product. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
Products::Variant resource).Output
Update Collection
Update Collection
CLICKFUNNELS_UPDATE_PRODUCTS_COLLECTIONSUpdate Collection. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Price
Update Price
CLICKFUNNELS_UPDATE_PRODUCTS_PRICESUpdate Price. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
GET /products/prices/{price_id}/change_options lists the upgrades and downgrades the API allows from this price.GET /products/prices/{price_id}/change_options lists the upgrades and downgrades the API allows from this price.Output
Update Tag
Update Tag
Update Variant
Update Variant
CLICKFUNNELS_UPDATE_PRODUCTS_VARIANTSUpdate Variant. API access tokens need store:write permission; the coarse write permission also authorizes this action.Input Parameters
has_access_to_all_valid_assets (set it false to grant only these). This replaces the current set.Product.course_id; a purchase grants access to it. When creating a grant, omit included_sections_attributes for FULL-course access, or list specific sections for PARTIAL access. On an existing grant, omitting sections does NOT convert partial access to full; manage sections explicitly (add via courses_section_id, remove via id + _destroy). To revoke the whole grant, pass its id with _destroy set to true.asset_ids to grant only specific ones.communities_space_group_id; a purchase grants access to the whole group. To revoke, pass the grant’s id with _destroy set to true.Output
Update Refine Filter
Update Refine Filter
Update Opportunity
Update Opportunity
CLICKFUNNELS_UPDATE_SALES_OPPORTUNITIESUpdate Opportunity. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.Input Parameters
Membership to assign the Opportunity to. An Opportunity can be assigned to any Team member since they have access to all your workspaces. You can get a list of available Memberships and their id via the Team resource’s memberships property. If the opportunity is already assigned to a team member, the assignee will be updated. You can unset the assignee by passing a null value for assignee_id.Output
Update Note
Update Note
CLICKFUNNELS_UPDATE_SALES_OPPORTUNITIES_NOTESUpdate Note. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Pipeline
Update Pipeline
Update Stage
Update Stage
CLICKFUNNELS_UPDATE_SALES_PIPELINES_STAGESUpdate Stage. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Segment
Update Segment
CLICKFUNNELS_UPDATE_SEGMENTSUpdate Segment. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
true for ids only; omit for the filter definition alone.Output
Update shipping addresses
Update shipping addresses
CLICKFUNNELS_UPDATE_SHIPPING_ADDRESSESUpdate shipping addresses. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Package
Update Package
Update Profile
Update Profile
Update Rate
Update Rate
Update Name
Update Name
Update Zone
Update Zone
Update Site
Update Site
CLICKFUNNELS_UPDATE_SITEUpdate Site. API access tokens need sites:write permission; the coarse write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields (e.g., expand[]=head_code&expand[]=footer_code). See the Expanding guide for available fields and examples.Output
Update Store
Update Store
Update Team
Update Team
CLICKFUNNELS_UPDATE_TEAMUpdate a team; if locale is omitted, the request sends English as the default locale. API access tokens need account:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Theme
Update Theme
CLICKFUNNELS_UPDATE_THEMESUpdate Theme. API access tokens need sites:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Short Link
Update Short Link
CLICKFUNNELS_UPDATE_URL_REDIRECTSUpdate a short link, sending a temporary redirect type by default unless another type is specified. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Incoming External Purchase Endpoint
Update Incoming External Purchase Endpoint
CLICKFUNNELS_UPDATE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_ENDPOINTSUpdate Incoming External Purchase Endpoint. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Incoming External Purchase Product Mapping
Update Incoming External Purchase Product Mapping
Update Endpoint
Update Endpoint
CLICKFUNNELS_UPDATE_WEBHOOKS_OUTGOING_ENDPOINTSUpdate Endpoint. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.Input Parameters
page_ids pass an empty array or null.funnel_ids pass an empty array or null.contact.updated, order.completed, orders/invoice.paid) — these are NOT numeric IDs. Retrieve the full list of valid keys from GET /api/v2/webhooks/outgoing/event_types (operationId: listWebhooksOutgoingEventTypes). The <a class=“link” href=“https://developers.myclickfunnels.com/docs/webhook-event-types” target=“_blank”>Webhook Event Types guide</a> provides supplementary context. On create, one or more valid event_type_ids are required. To remove one event_type_id on update, pass an array of all current event_type_ids less the one to be removed. On update to remove all event_type_ids pass an empty array.Output
Update Workflow
Update Workflow
CLICKFUNNELS_UPDATE_WORKFLOWUpdate Workflow. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.Input Parameters
asynchronous allows multiple simultaneous runs per contact, synchronous allows multiple runs per contact back to back (no new run while one is in progress), and one_time runs each contact at most once.Output
Update Step
Update Step
CLICKFUNNELS_UPDATE_WORKFLOW_STEPUpdate Step. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.Input Parameters
send_email_step update cannot change template_id (it is create-only — including it returns 422); edit the email in place with html_body/text_body instead, or create a new step to use a different template. See the step_type_settings field on the Workflows::Step response schema (#/components/schemas/WorkflowsStepAttributes) for the full per-type field catalog, the send_email_step inline-body rules, and FK id handling.Output
Update Trigger
Update Trigger
CLICKFUNNELS_UPDATE_WORKFLOW_TRIGGERUpdate Trigger. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.Input Parameters
Output
Update Workspace
Update Workspace
Upsert a Contact
Upsert a Contact
CLICKFUNNELS_UPSERT_CONTACTSUpsert a Contact. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.Input Parameters
expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.snake_case (For example, ‘Favorite Food! 🥑’ will be converted to ‘favorite_food’). Empty keys will trigger a bad request response. Also, non-object inputs for custom_attributes (e.g. an array or string), it will be ignored. Keys that are default properties on the Contact resource or variations of it will result in an error. E.g., ‘first_name’, ‘First Name’, etc. are not valid inputs.