Skip to main content
ClickFunnels 2.0 logo
  • Category: marketing automation
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 476
  • Triggers: 0
  • Slug: CLICKFUNNELS
  • Version: 20261101_00

Tools

Slug: CLICKFUNNELS_ABANDON_ORDERS_INVOICESAbandon Invoice. This can trigger an irreversible external effect. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_APPROVE_COMMUNITIES_SPACES_POSTApprove Post. This can trigger an irreversible external effect. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_APPROVE_COMMUNITIES_SPACES_POSTS_COMMENTApprove Comment. This can trigger an irreversible external effect. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_ARCHIVE_EMAILS_TOPICArchive Email Topic. This permanently removes the targeted resource. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_ARCHIVE_FUNNELSArchive a Funnel. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
array
Expand additional data in the response. Use expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_ARCHIVE_PRODUCTSArchive a Product. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CANCEL_FULFILLMENTSCancel a Fulfillment. This can trigger an irreversible external effect. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string
Attribution for who or what requested the cancelation. It is persisted on the order and recorded in its audit timeline. Defaults to API.
string
The reason code for the cancelation. Defaults to 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, other
string
When the cancelation takes effect. - next_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.
array
IDs of the order’s invoices to void as part of the cancelation. When omitted, all of the order’s open (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.
string
A free-text description of the cancellation reason.
boolean
Whether to prorate the cancelation. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_BLOG_POSTCreate Blog Post. API access tokens need blog:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Title of the post
string
PML (Page Markup Language) builds the rendered post body and replaces its content tree, published version, and editor draft. Because PML supports only part of the ClickFunnels editor, writing it over an existing body can silently drop unsupported editor content. If the post could have been written or edited in the ClickFunnels editor, get explicit user approval before sending this on update; a general update request is insufficient. Omit 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.
string
required
Identifier used for the blog id path segment.
array
IDs of tags to associate with the post
array
Expand additional data in the response. Use 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.
integer
Featured image ID. When importing an article, its images need rehosting first: see Rehost source images during a migration and the image caveat.
string
SEO page title
array
IDs of authors to associate with the post
string ("draft" | "public" | "members_only" | "scheduled")
Visibility status. One of draft, public, members_only, or scheduled. See Two gotchas worth knowing in the Blogs Skill.
array
IDs of categories to associate with the post
string
Date and time to publish the post. Required when visibility is scheduled. See Publish separately in the Import External Blog Post Skill.
string
Short summary of the blog post
string
SEO page description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_BLOG_TAGCreate Blog Tag. API access tokens need blog:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Tag name
string
required
Identifier used for the blog id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIESCreate Community. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Community Name
string
Status of the community (e.g. live, draft)
boolean
Make this Community Private?
string
Seo Title
boolean
Invite Only?
string
Upgrade URL
boolean
Enable White Label
string
Current Path
string
required
Identifier used for the workspace id path segment.
integer
Logo Image ID
string
Notification settings (e.g. all, essential, off)
boolean
Seo Indexable?
string
Seo Description
integer
Social Image ID
boolean
Anyone Can Invite?
boolean
Enable Block List?
boolean
Send Digest Email?
boolean
Allow Public Sign-Up?
boolean
Send Membership Email?
boolean
Require Post Approvals?
boolean
Require Comment Approvals?

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_BANSCreate Ban. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Optional reason for the ban (max 1024 characters)
string
required
Public ID of the Contact to ban
string
required
Identifier used for the community id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_BANS_EXPORT_ACTIONSCreate Ban Export 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

array
Array of column names to include in the export
boolean
When true, export all bans in the community (target_ids is ignored)
array
Array of ban public IDs to export. Required when target_all is false.
string
required
Identifier used for the community id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_BANS_UNBAN_ACTIONSCreate Ban Unban 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

boolean
When true, unban all banned contacts in the community (target_ids is ignored)
array
Array of ban public IDs to unban. Required when target_all is false.
string
required
Identifier used for the community id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPSCreate Membership. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

boolean
Whether this member should have moderator privileges
array
Array of Space public IDs the member should belong to. The membership form syncs the member’s Space memberships to exactly this list — Spaces not in the list are removed, Spaces in the list are added.
string
required
Public ID of the Contact to add as a member
string
required
Identifier used for the community id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPS_ADD_TO_GROUP_ACTIONSCreate Membership Add-To-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

array
Array of space public IDs to add the members to
boolean
When true, add all members in the community to the specified spaces (target_ids is ignored)
array
Array of membership public IDs to add to the spaces. Required when target_all is false.
string
required
Identifier used for the community id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPS_BAN_ACTIONSCreate Membership Ban 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

string
Optional reason applied to each ban
boolean
When true, ban all members in the community (target_ids is ignored)
array
Array of membership public IDs to ban. Required when target_all is false.
string
required
Identifier used for the community id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPS_EXPORT_ACTIONSCreate Membership Export Action. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

array
Array of column names to include in the export
boolean
When true, export all members in the community (target_ids is ignored)
array
Array of membership public IDs to export. Required when target_all is false.
string
required
Identifier used for the community id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Array of space public IDs to remove the members from
boolean
When true, remove all members in the community from the specified spaces (target_ids is ignored)
array
Array of membership public IDs to remove from the spaces. Required when target_all is false.
string
required
Identifier used for the community id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_SPACE_GROUPSCreate Space Group. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name
string
Emoji icon for the group
integer
Access level (0 = open, 1 = private, 2 = secret)
boolean
Always On
boolean
Only show joined Topics
integer
Group type (integer enum)
integer
Sort order within the community
string
Description
string
Upgrade URL
string
required
Identifier used for the community id path segment.
string
Current Path
integer
Card Image ID
string
Approval Terms
boolean
Automatically add members to new Topics within this Group
boolean
Require approvals for posts in this Group?
boolean
Require approvals for comments in this Group?
boolean
Hide from non-members
boolean
Override community-level post approval setting for this group
boolean
Override community-level comment approval setting for this group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_SPACESCreate Space. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name
string
Emoji icon for the space
integer
Access level (0 = open, 1 = private, 2 = secret)
boolean
Always On
string
Seo Title
integer
Sort order within the space group
string
Default tab shown when viewing the space
string
Upgrade URL
string
Current Path
string
Layout style for the space
integer
Card Image ID
string
required
Identifier used for the space group id path segment.
string
Seo Description
integer
Social Image ID
boolean
Whether members can post in this space
boolean
Whether posts can have titles
string
Default sort order for posts
boolean
Whether posts can have cover images
Whether to hide this space from the featured spaces list
boolean
Whether members can invite others to this space
string
Label for pinned posts section
string
Default sort order for members
string
Default sort order for comments

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTSCreate Post. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Post body as rich HTML
string
required
Post title
integer
Cover image ID
string
required
Identifier used for the space id path segment.
boolean
Whether to pin the post at the top of the space
integer
ID of the Contact to author the post. Optional — defaults to the connected user’s own contact.
string
Current path (used for tracking purposes)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTS_COMMENTSCreate Comment. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Comment body as rich HTML
string
required
Identifier used for the post id path segment.
integer
ID of the Contact to author the comment. Optional — defaults to the connected user’s own contact.
integer
ID of the parent comment for threaded replies. Must be a comment on the same post.
boolean
When true, suppresses email/push notifications for this comment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the comment id path segment.
integer
ID of the Contact to record the like for. Optional — defaults to the connected user’s own contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the post id path segment.
integer
ID of the Contact to record the like for. Optional — defaults to the connected user’s own contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Source URL of the video
object
Provider-specific metadata (arbitrary key/value pairs)
string
required
Identifier used for the post id path segment.
string ("youtube" | "vimeo" | "loom" | "voomly")
Video provider name. Optional and effectively ignored — the provider is auto-detected from the URL on save (set_provider before_save). One of youtube, vimeo, loom, voomly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_CONTACTSCreate Contact. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Facebook URL
array
Contact Tag IDs. Any valid array, empty or with valid tags will overwrite existing values. To avoid losing existing tags first use the Fetch Contact endpoint, then be sure to include the existing tags in your payload along with any new addition(s).
array
Expand additional data in the response. Use expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.
string
Last name
string
The human-readable time zone, usually set dynamically by the app for the contact, for example, during opt-in. Read more about time zones and how to map them back to the TZ standard in our Time Zones guide..
string
First name
string
Twitter URL
string
Website URL
string
LinkedIn URL
string
Phone number
string
required
Identifier used for the workspace id path segment.
string
Email address
string
Instagram URL
object
Custom attributes are usually added in ClickFunnels to a contact when they submit forms that contain custom contact attributes. Here you can directly create them during contact modification. Custom attributes are provided as key-value pairs: A key that does not exist, will create a new custom contact attribute. A key that already exists, will update the value of an existing custom contact attribute. Empty or null values, will set the custom attribute values to empty strings. A key that has special characters or spaces will be automatically converted to 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_CONTACTS_APPLIED_TAGSCreate Applied Tag. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

integer
required
Tag ID
string
required
Identifier used for the contact id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_CONTACTS_BILLING_ADDRESSCreate contact billing address. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
City
string
State code or full region name for the country; unknown values return 422
string
required
Identifier used for the contact id path segment.
string
required
Street line 1
string
Street line 2
string
required
Postal code, at most 10 characters
string
required
ISO2 country code; unknown values return 422

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
A URL-encoded Refine 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.
array
Public IDs of the courses to enroll contacts into. Contacts are enrolled into every section of each course. Provide course_ids, section_ids, or both.
boolean
Set to true to target every contact in the workspace. Use deliberately. Mutually exclusive with stable_id, stored_filter_id, and target_ids.
array
Explicit list of contacts to enroll, as the public_id strings returned by the contacts endpoints. Numeric ids are also accepted. Mutually exclusive with stable_id, stored_filter_id, and target_all.
array
Public IDs of specific course sections to enroll contacts into. Use when you want finer-grained control than course_ids.
string
required
Identifier used for the workspace id path segment.
string
Optional ISO 8601 datetime. When supplied the action is deferred until this time. Omit (or pass null) to execute immediately.
string
The 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Required nonblank text on creation; no length cap.
string
required
Identifier used for the contact id path segment.
string
Optional ISO 8601 timestamp. Defaults to server time on creation; omission on update preserves its occurrence time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_CONTACTS_EXPORT_ACTIONSCreate Export Action. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

array
required
The contact field keys to include as columns in the exported CSV. Standard keys include email_address, first_name, last_name, tag_ids, phone_number, etc. Custom attribute keys are also accepted. Required.
string
A URL-encoded Refine 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.
boolean
Set to true to target every contact in the workspace. Use deliberately. Mutually exclusive with stable_id, stored_filter_id, and target_ids.
array
Explicit list of contacts to export, as the public_id strings returned by the contacts endpoints. Numeric ids are also accepted. Mutually exclusive with stable_id, stored_filter_id, and target_all.
string
required
Identifier used for the workspace id path segment.
string
Optional ISO 8601 datetime. When supplied the action is deferred until this time. Omit (or pass null) to execute immediately.
string
The 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
When true, contacts already enrolled in the workflow are re-enqueued. Defaults to false.
string
A URL-encoded Refine 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.
boolean
Set to true to target every contact in the workspace. Use deliberately. Mutually exclusive with stable_id, stored_filter_id, and target_ids.
array
Explicit list of contacts to run the workflow against, as the public_id strings returned by the contacts endpoints. Numeric ids are also accepted. Mutually exclusive with stable_id, stored_filter_id, and target_all.
string
required
The public_id of the workflow to run against the targeted contacts. Required.
string
required
Identifier used for the workspace id path segment.
string
Optional ISO 8601 datetime. When supplied the action is deferred until this time. Omit (or pass null) to execute immediately.
string
The 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
One or more tag 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).
string
A URL-encoded Refine 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.
boolean
Set to true to target every contact in the workspace. Use deliberately. Mutually exclusive with stable_id, stored_filter_id, and target_ids.
array
Explicit list of contacts to tag/untag, as the 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.
string ("add" | "remove")
"add" (default) applies the tags; "remove" removes them.
string
required
Identifier used for the workspace id path segment.
string
Optional ISO 8601 datetime. When supplied the action is deferred until this time. Omit (or pass null) to execute immediately.
string
The 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_CONTACTS_TAGSCreate Tag. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name
string
Tag Color
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
A URL-encoded Refine 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.
boolean
Set to true to target every contact in the workspace. Use deliberately. Mutually exclusive with stable_id, stored_filter_id, and target_ids.
array
Explicit list of contacts to unsubscribe, as the public_id strings returned by the contacts endpoints. Numeric ids are also accepted. Mutually exclusive with stable_id, stored_filter_id, and target_all.
string
required
Identifier used for the workspace id path segment.
string
Optional ISO 8601 datetime. When supplied the action is deferred until this time. Omit (or pass null) to execute immediately.
string
The 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_CONTACTS_UNSUBSCRIBED_TOPICSOpt a Contact out of a Topic. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

integer
required
An active topic ID in the contact’s workspace.
string
required
Identifier used for the contact id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COURSESCreate Course. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Title
integer
The ID of an Image to show on the storefront of the main course page
string
Description
string
required
Identifier used for the workspace id path segment.
boolean
Show In Customer Center?
boolean
Redirect To Full Course

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COURSES_ENROLLMENTSCreate Enrollment. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the course id path segment.
boolean
Suspended
integer
required
Contact ID
string
Suspension Reason

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COURSES_LESSON_COMPLETIONSCreate Lesson Completion. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the course id path segment.
integer
required
The ID of the Courses::Lesson record that was completed
integer
required
The ID of the Courses::Enrollment record that completed the lesson

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COURSES_LESSONSCreate Lesson. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Description
string
Title
string
Public ID of an image in the workspace to use as the lesson image.
string
required
Identifier used for the section id path segment.
string
Markdown lesson content. This is the primary content field for the lesson body. It is Markdown, not PML. See Lessons in the Courses Skill.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_COURSES_SECTIONSCreate Section. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Title
string
required
Identifier used for the course id path segment.
string
Description
integer
Blocker lesson
integer
Blocker section
integer
Days until drip access
boolean
Current Path

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the course id path segment.
boolean
When true (requires auto_enroll: true), enrolled contacts receive an email notification about the newly published sections.
boolean
Set to 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.
array
Array of course-section public IDs to publish. Mutually exclusive with target_all. Exactly one of target_ids or target_all must be supplied.
boolean
When true, existing course enrollees are granted access to the newly published sections automatically.
string
Optional ISO 8601 datetime. The publish is deferred until this time. Must be a future datetime. Omit to publish immediately.
boolean
When true, products that grant full course access are updated to also include the newly published sections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Page name.
object
Optional funnel association — provide either funnel_id or show_page_step_id. Omit the whole block to create a standalone page.
integer
Optional zero-based position within the funnel when using funnel.funnel_id (422 without it). 0 inserts before the first step; omit to append. Ignored when funnel.show_page_step_id is used.
string
required
The complete HTML document to serve (max 2MB).
string
A short description of the page (max 1000 characters).
string
Optional URL path on the funnel’s domain (e.g. /my-landing). Derived from the name when omitted.
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_DISCOUNTSCreate Discount. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Required for a 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).
string
required
Internal name for the discount.
string
Fixed amount off as a decimal string. Required when discount_method is fixed.
string
Percentage off (0.01-100). Required when discount_method is percentage.
string
ISO currency code. Defaults to the workspace currency.
string ("all_products" | "specific_products" | "specific_variants" | "specific_collections")
Defaults to all_products.
string
When the discount becomes active. Defaults to now. Set in the future to schedule it.
string
When the discount expires. Omit for no expiry. There is no 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 } }.
array
Product ids to scope to, when applies_to is specific_products.
array
Variant ids to scope to, when applies_to is specific_variants.
string
required
Identifier used for the workspace id path segment.
string ("code" | "automatic" | "sale")
Defaults to code.
string ("percentage" | "fixed" | "shipping" | "bogo")
Defaults to percentage. percentage requires percent; fixed requires a positive amount.
boolean
Value for the limit 1 per customer request field.
boolean
Value for the require minimum spend request field.
array
Collection ids to scope to, when applies_to is specific_collections.
integer
Value for the discounts per redemption request field.
integer
Minimum order subtotal, in whole currency units rather than cents - 50 on a usd discount means $50. Must be positive when require_minimum_spend is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_EMAILS_ADDRESSESCreate Email Address. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
The from-name shown to recipients (e.g. “Acme Support”). Required when creating.
string
Optional internal label.
string
Selects among ClickFunnels’ shared sending domains only; normally omit it to get the default (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.
string
required
The local part before the @ (e.g. “hello” for hello@yourdomain.com). Required when creating.
string
required
Identifier used for the workspace id path segment.
integer
Numeric 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_EMAILS_BROADCASTCreate Email Broadcast. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional ISO 8601 datetime. When provided, the broadcast is scheduled for that day at the given hour in the workspace’s time zone. Omit (or send an empty body) to dispatch immediately.
string
required
Identifier used for the broadcast id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_EMAILS_DOMAINSCreate Email Domain. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
A valid public bare root domain name to provision as a sending domain (e.g. 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.
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_EMAILS_TEMPLATECreate Email Template. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Internal name for the template (required)
string
Default email subject line. May be blank.
string
HTML email body
string
Plain text email body
string
required
Identifier used for the workspace id path segment.
integer
ID of a sending address that belongs to this workspace. Pick one whose top-level 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_EMAILS_TOPICCreate Email Topic. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Topic name
string
Topic description
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_EXTERNAL_PAGECreate External Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Page name. Defaults to the URL host if omitted.
object
Optional funnel association — provide either funnel_id or show_page_step_id. Omit the whole block to create a standalone external page (no funnel step).
integer
Optional zero-based position within the funnel when using funnel.funnel_id (422 without it). 0 inserts before the first step; omit to append. Ignored when funnel.show_page_step_id is used.
string
A short description of the page (max 1000 characters).
string
required
The fully-qualified URL of the externally-hosted page (e.g. https://acme.example.com/my-page). Must be unique within the workspace.
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FORMSCreate Form. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FORMS_FIELDSCreate Field. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Key
string
required
Label
boolean
Hidden
string
Field Type
string
required
Identifier used for the field set id path segment.
boolean
Allow Multiple

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FORMS_FIELD_SETSCreate Field Set. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Title
string
required
Identifier used for the form id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FORMS_FIELDS_OPTIONSCreate Option. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Label
string
required
Identifier used for the field id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FORMS_SUBMISSIONSCreate Submission. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the form id path segment.
integer
Contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FORMS_SUBMISSIONS_ANSWERSCreate Answer. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Entry
integer
required
Field
string
required
Identifier used for the submission id path segment.
integer
ID of a record from the Forms::Fields::Option API.
array
Fields Options

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FULFILLMENTSCreate Fulfillment. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

integer
required
The contact that made the order that is being fulfilled.
integer
required
The location that the fulfillment is being fulfilled from
string
Tracking URL
string
required
Identifier used for the workspace id path segment.
string
Tracking Code
boolean
Send an email to the customer when the fulfillment is created. Will use workspace default behavior if left unset.
string
Shipping Provider
boolean
Create a fulfillment despite the item being out of stock.
array
required
The orders invoices line items to fulfill as part of this fulfillment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FULFILLMENTS_LOCATIONSCreate Location. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Location name
object
Value for the address request field.
boolean
Indicates if the location is archived
string
required
Address name
boolean
Indicates a location managed by an external integration. Only to be used for requests made with Oauth 2.0 access tokens. External app locations do not need to provide an address.
string
Phone number
string
required
Identifier used for the workspace id path segment.
string
required
Email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FUNNELCreate Funnel. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name of the Funnel
array
An array of tag IDs to associate with this funnel
integer
The ID of the domain to associate with this funnel. Use the Domains API to look up available domain IDs.
string
Custom code to inject into the funnel’s <head> section. Content should be wrapped in appropriate HTML tags such as <script>, <link>, <meta>, or <style>.
boolean
Controls test versus live payment processing, not page visibility or publication. True enables live payments; false keeps test mode. Page content is saved live through the Pages API.
Custom code to inject before the closing </body> tag. JavaScript should be wrapped in <script> tags.
string
The URL path for the funnel. If not provided, a path will be auto-generated from the name.
string
required
Identifier used for the workspace id path segment.
string ("append" | "replace")
How to handle head_code. ‘append’ adds to existing code (default), ‘replace’ overwrites.
How to handle footer_code. ‘append’ adds to existing code (default), ‘replace’ overwrites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional 0..2 branch entries; branches[0] is the matched branch, branches[1] is the unmatched branch.
object
Value for the condition request field.
string
required
Identifier used for the funnel id path segment.
string
Optional. Insert the new conditional split AFTER the workflow step that wraps this 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FUNNELS_CLONE_ACTIONSDuplicate Funnel Asynchronously. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Source funnel integer ID or public ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
1 or 2 variant entries.
string
required
Identifier used for the funnel id path segment.
string
Optional. Insert the new split AFTER the workflow step that wraps this 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_FUNNELS_TAGSCreate a funnel tag in a workspace. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
The name of the funnel tag
string
The color of the funnel tag
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_IMAGESCreate Image. API access tokens need media:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Image name
string
Image alt attribute
string
required
Identifier used for the workspace id path segment.
string
required
The source URL of the image that you want to upload. Not required on Update when not needed to re-upload the image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_ORDERSCreate External Order. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Your internal note about the order. This will be visible in ClickFunnels admin orders-related sections.
boolean
required
Required. Indicates if the Order is for production or testing. - true: The order is a live/production order. - false: The order is a test order.
string
Churned At
integer
The ID of the contact associated with the order. Either contact_id or contact_attributes must be provided, but not both. If both are provided, contact_id takes precedence.
string ("one-time-order" | "subscription-order")
required
The type of order. Required for creating orders. - 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.
string
Order Canceled At
string
Order Canceled By
string
An external ID, e.g., a payment provider’s ID or an ID managed by the client internally
string
Date Activated
string
required
Identifier used for the workspace id path segment.
string
The reason code for the cancelation, it is required when canceling an order. Possible codes for Payments AI orders are: 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.
string
The billing status reflects the status of the invoice of an order. Billing status can be one of the following for Payments AI and Stripe orders: 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.
string
The date and time of the next scheduled charge for subscription orders. (External subscription orders only)
string
The service status reflects the activity state of the order. For subscriptions, it can control whether a subscription is ongoing, for example despite an irregular (unpaid) invoice status. For orders with Payments AI as the payment processor, it can be one of the following: 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.
string
A free-text description of the cancellation reason.
object
Alternative to 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.
string
The city of the billing address.
array
required
Line items for the order. At least one line item is required. Each line item must include a valid variant_id, products_price_id, and quantity.
string
The city of the shipping address.
string
The region of the shipping address, like state or province.
string
The billing address country.
string
The region of the shipping address, like state or province.
string
The country of the shipping address.
string
The main street information of the billing address, including the street name and number.
string
Additional street information of the billing address, like entrance information and apartment numbers.
string
The last name of the recipient’s shipping address.
string
Billing address postal (ZIP) code.
string
The first name of the recipient’s shipping address.
string
The main street information of the shipping address, including the street name and number.
string
Additional street information for the shipping address, like entrance information and apartment numbers.
string
Postal Code
string
The phone number of the recipient’s shipping address.
string
The organization name of the recipient’s shipping address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_ORDERS_APPLIED_TAGSApply a tag to an order. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

integer
required
Tag ID
string
required
Identifier used for the order id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_ORDERS_INVOICESCreate External Invoice. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
The date the invoice is due.
string ("unpaid" | "paid" | "voided" | "refunded" | "disputed" | "past-due")
required
Required. The billing status of the invoice. For external one-time orders, valid statuses are: 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.
string
The date the invoice was paid. Required when status is paid.
string
required
Identifier used for the order id path segment.
string
The date the invoice was issued.
string
required
Required. A unique identifier for this invoice in your external system. This ID allows you to correlate ClickFunnels invoices with records in your payment processor.
string ("initial" | "renewal" | "interim" | "cancellation" | "one_time" | "refund" | "charge" | "one_time_sale")
The type of invoice. If not provided, defaults based on the order type: - For one-time orders: 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.
string
Optional. A sequential number for bookkeeping purposes. If not provided, one will be auto-generated.
string
Invoiced shipping amount. Cannot be negative. Defaults to “0.00”.
array
Line items for the invoice. Each line item represents a product/variant being invoiced. Required fields for each line item: amount, quantity, variant_id, products_price_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_ORDERS_TAGSCreate Tag. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name (maximum 40 characters)
string
Tag Color
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_PAGECreate Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Page name of the editable page element.
array
Expand additional data in the response. Use 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.
object
Optional funnel association. Use either funnel_id (to create a new step) or show_page_step_id (to attach to existing step). If both are provided, show_page_step_id takes precedence and funnel_id is ignored.
string
A valid PML (Page Markup Language) string that replaces the page’s visual tree. Page metadata (name, path, SEO settings) is preserved. Markup that stops mid-construct (a tag, attribute value, comment or <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.
integer
The ID of the theme to use for this page.
string
Custom code to inject into the page’s <head> section. Content should be wrapped in appropriate HTML tags such as <script>, <link>, <meta>, or <style>. Set to null to clear existing code.
boolean
Whether search engines should index this page. Defaults to false.
string
Custom title for search engine results.
string
Raw CSS to apply at the page level (no <style> wrapper). Maps to the CSS tab in the page editor’s Code Editor panel. Internal pages only. Set to null to clear existing CSS.
integer
Optional zero-based position within the funnel when creating with 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.
string
A short description of the page (max 1000 characters).
Custom code to inject before the closing </body> tag. JavaScript should be wrapped in <script> tags. Set to null to clear existing code.
string
The URL path for the page. If left blank, a randomized path will be generated. When attaching to a funnel, this value becomes the ShowPageStep path (the user-facing URL), and the page’s own current_path will be set to a randomized value with a suffix, since the ShowPageStep path is the source of truth for funnel pages. See Setting a page’s path (current_path) in the Pages Skill for the path rules.
string
required
Identifier used for the workspace id path segment.
string ("append" | "replace")
How to handle head_code. ‘append’ adds to existing code (default), ‘replace’ overwrites.
object
Optional. Mutates the show_page_step that the page is attached to via the 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.
Block AI answer engines (OAI-SearchBot, PerplexityBot and others) from indexing this page and citing it in answers. Defaults to false. See Crawler access (AI opt-out) in the Pages Skill for coverage limits.
string ("append" | "replace")
How to handle custom_css. ‘append’ adds to existing CSS (default), ‘replace’ overwrites.
string
Custom meta description for search engine results.
boolean
Block AI training crawlers (GPTBot, ClaudeBot, Google-Extended and others) from using this page’s content to train models. Defaults to false. Enforced via robots.txt — see Crawler access (AI opt-out) in the Pages Skill for coverage limits.
How to handle footer_code. ‘append’ adds to existing code (default), ‘replace’ overwrites.
boolean
Block AI assistants (ChatGPT-User, Claude-User and others) from opening this page when a person asks them to. Defaults to false. See Crawler access (AI opt-out) in the Pages Skill for coverage limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_PRODUCTSCreate Product. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Product name
array
Any valid array, empty or with valid tag ids will overwrite existing values. To avoid losing existing tags first use the Fetch Product endpoint, then be sure to include the existing tags in your payload along with any new addition(s)
array
Images
string
A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters.
string
Current Path
string
SEO image
string
required
Identifier used for the workspace id path segment.
boolean
Commissionable
string
A clear SEO description, at least two sentences long. Longer is better, but max is 160 characters. You will find the actual user-facing description on the default variant of the product (see the Products::Variant resource).
boolean
Visible in Store
string
Redirect funnel
array
The properties of the product’s variants. e.g. ‘Size’, ‘Color’ etc.
string
Cancellation Funnel Url
boolean
Visible in Customer Center

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_PRODUCTS_COLLECTIONSCreate Collection. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name of the products collection
string
Collection image
string
Title of the collection for SEO purposes
string
Description of the collection
array
Array of product IDs in the collection. Updating with invalid or non-workspace product IDs will result in an error. If IDs from existing products in the collection are left out, they will be removed from the collection. You can also remove all the products from a collection by providing an empty array.
string ("manually" | "name_asc" | "name_desc" | "price_desc" | "price_asc" | "added_at_desc" | "added_at_asc" | "created_at_desc" | "created_at_asc")
Method used to sort the products in the collection
string
required
Identifier used for the workspace id path segment.
string
Type of the collection (manual or automatic)
string
Description of the collection for SEO purposes
string
Image for social sharing
boolean
Whether the collection is visible in the online store

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_PRODUCTS_PRICESCreate Price. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Key
string
Cost
string
Name
string
required
Amount, as a decimal string. Omitting it does not fail — it silently creates a free price (‘0.00’) — so always send it.
boolean
Visible
boolean
Archived
string
Currency. Ignored on write — a price always takes its workspace’s currency, so sending a different one has no effect.
integer
Amount of payments. Required when payment_type is payment_plan; ignored for one_time and subscription.
string ("days" | "weeks" | "months" | "quarters" | "years")
Billing period unit — note the values are plural (‘months’, not ‘month’). Required when payment_type is subscription or payment_plan; ignored for one_time.
string
required
Identifier used for the variant id path segment.
boolean
Customer can cancel
string ("one_time" | "subscription" | "payment_plan")
Defaults to ‘one_time’ if left blank
boolean
Legacy setting with no effect: no checkout, customer portal or API plan change reads it. GET /products/prices/{price_id}/change_options lists the upgrades and downgrades the API allows from this price.
string
Setup amount
string
Amount charged for the trial. Leave at ‘0.00’ for a free trial, or set it above 0 for a paid one. Only applies when trial_interval and trial_duration are both set.
integer
How many intervals between charges — interval ‘months’ with interval_count 3 bills every 3 months. Required when payment_type is subscription or payment_plan.
boolean
Legacy setting with no effect: no checkout, customer portal or API plan change reads it. GET /products/prices/{price_id}/change_options lists the upgrades and downgrades the API allows from this price.
integer
Length of the trial, in trial_interval units. Send a positive value together with trial_interval to create an active trial. Sent alone, it is stored but remains inactive until trial_interval is added later.
string ("days" | "weeks" | "months" | "quarters" | "years")
Trial period unit — same plural values as interval. An active recurring trial needs BOTH trial_interval and a positive trial_duration. Send both together: trial_duration alone is stored but inactive until trial_interval is added later, while trial_interval alone is cleared. Trial fields are cleared on a one_time price.
boolean
Customer can reactivate
string
Compare at amount

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_PRODUCTS_TAGSCreate Tag. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name (maximum 40 characters)
string
The color of the product tag
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_PRODUCTS_VARIANTSCreate Variant. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
SKU
string
required
Name
number
Width
number
Height
number
Length
number
Weight
string
Taxable
boolean
Is visible
boolean
Archived
array
Digital-asset access. The IDs of workspace Assets a purchase of this variant should grant access to. Pair with has_access_to_all_valid_assets (set it false to grant only these). On update this replaces the current set.
array
The images for the variant.
string
required
Identifier used for the product id path segment.
string
The description of the variant. The description of the default variant is the user-facing description of the Product.
string
required
Weight unit
string ("physical" | "digital")
required
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.
boolean
Track Quantity
string
Dimensions unit
string
Tax category ID
array
required
The property values of the Variant. e.g. ‘Large’, ‘Red’ etc.
boolean
Out of stock sales
boolean
Fulfillment required
string
Country of manufacture
array
The fulfillment locations for the variant.
array
Course access to grant. Each entry links a Course by 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.
boolean
All-or-nothing digital-asset access. When true, a purchase grants access to every valid Asset. Set false and pass asset_ids to grant only specific ones.
array
Community access to grant. Each entry links a Community Space Group by 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SALES_OPPORTUNITIESCreate Opportunity. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name
number
The potential value of this opportunity in the default currency of the workspace
string
Close date
integer
The ID of the Team Membership to assign the Opportunity to. An Opportunity can be assigned to any Team member since they have access to all your workspaces. You can get a list of available Memberships and their id via the Team resource’s memberships property. If the opportunity is already assigned to a team member, the assignee will be updated. You can unset the assignee by passing a null value for assignee_id.
string
required
Identifier used for the workspace id path segment.
integer
required
Pipeline Stage
integer
required
Primary Contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SALES_OPPORTUNITIES_NOTESCreate Note. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Content
integer
The ID of the Team-Membership that created the note. When creating notes via the API, this defaults to the ClickFunnels API default User’s Membership ID. You can retrieve a list of available Memberships and their id via the Team resource’s memberships property.
string
required
Identifier used for the opportunity id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SALES_PIPELINESCreate Pipeline. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Pipeline name
string
required
Identifier used for the workspace id path segment.
array
required
The stages of the pipeline. The stages are ordered by the position attribute.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SALES_PIPELINES_STAGESCreate Stage. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Stage name
integer
The position of the stage in the pipeline. The stages are ordered by the sort order attribute, starting at zero. If not provided, the stage will be added at the end of the pipeline. If provided, the stage will be inserted at the specified position, and the sort order of the subsequent stages will be incremented by one.
string
required
Identifier used for the pipeline id path segment.
number
required
Close probability of the opportunities in this stage

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SEGMENTSCreate Segment. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Return matching contacts inline; omit for the audience definition alone. Requires contacts:read. Count is opt-in.
object
required
Value for the segment request field.
string
Return projected matches inline. Pass true for ids only; omit for the filter definition alone.
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SHIPPING_ADDRESSESCreate shipping addresses. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

object
required
Complete postal street. Row IDs, owner fields, internal geography IDs and checkout verification are read-only and ignored if supplied.
boolean
Set true to select this entry. False on the current default returns 422; select another entry instead.
string
Last name
string
required
Contact ID
string
First name
string
Phone number
string
Organization name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SHIPPING_PACKAGESCreate Package. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name
number
required
Width
number
required
Height
number
required
Length
number
Weight
string ("fedex" | "ups" | "usps")
Carrier
string ("lb" | "kg" | "g" | "oz")
Weight Unit
string
Empty Weight
string ("box" | "envelope" | "soft_package")
required
Package Type
string
required
Identifier used for the workspace id path segment.
string ("in" | "cm" | "ft" | "m" | "mm")
required
Distance Unit
boolean
Default Package

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SHIPPING_PROFILESCreate Profile. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name
array
Variant IDs
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SHIPPING_RATESCreate Rate. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Price
string
required
Identifier used for the zone id path segment.
string
Provider Name
integer
required
Rate name ID
string
Price Currency
string
Live Rates Provider

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SHIPPING_RATES_NAMESCreate Name. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Rate Name
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_SHIPPING_ZONESCreate Zone. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name
array
Region IDs
array
Country IDs
string
Zone
string
required
Identifier used for the location group id path segment.
boolean
Includes Rest of the World

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_STORESCreate Store. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Name
string ("draft" | "published")
Store Status
string
SEO title
string
Current path
string
required
Identifier used for the workspace id path segment.
boolean
SEO Indexable
string
SEO description
string
Social image

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Human-readable endpoint name.
string ("clickbank" | "offerlab" | "copecart" | "whop")
required
External commerce provider. This cannot be changed after creation.
boolean
Whether this endpoint receives live rather than test purchases.
string
required
Identifier used for the workspace id path segment.
boolean
Whether ClickFunnels suppresses its order system emails for purchases received by this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_PRODUCT_MAPPINGSCreate Incoming External Purchase Product Mapping. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Integer database id or obfuscated public_id.
string
required
Integer database id or obfuscated public_id.
string
required
Provider product, plan, or SKU identifier. For Whop, use the plan ID.
string
required
Integer ID or obfuscated public ID of the incoming external purchase endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_WEBHOOKS_OUTGOING_ENDPOINTSCreate Endpoint. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
The URL that ClickFunnels event webhooks will be sent to.
string
required
The custom name for the webhook endpoint.
array
The pages scope of the webhook, i.e., the endpoint will only subscribe to events triggered by users from the pages with the given IDs. If not configured initially (equalling null) or empty, subscribes to events fired from any page in the workspace. Updating the array will override existing values. To remove all page_ids pass an empty array or null.
array
The funnel scope of the webhook, i.e., the endpoint will only subscribe to events triggered by users from the funnels with the given IDs. If not configured initially (equalling null) or empty, subscribes to events fired from any funnel in the workspace. Updating the array will override existing values. To remove all funnel_ids pass an empty array or null.
string
required
Identifier used for the workspace id path segment.
array
The event type keys to which the webhook endpoint subscribes. Each value is a dotted or slashed string key (e.g. 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_WORKFLOWCreate Workflow. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Human-readable name for the workflow.
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_WORKFLOW_RUNEnroll Contact (Create Run). API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Integer database id or obfuscated public_id.
string
required
Integer id or obfuscated public_id of the workflow.
boolean
When true, communication steps (send email, chat message, etc.) are skipped for this run. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_WORKFLOW_STEPCreate Step. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Optional human-readable name. Defaults to a titleized version of the step type.
string
Branch selector — matched/unmatched for conditional splits (legacy match/fallback still accepted); "0"/"1" for split tests.
integer
0-based position within the container. Mutually exclusive with after_step_id.
string
required
Integer id or obfuscated public_id of the workflow.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
object
required
Exactly one key naming the step type, with its settings as the value. On a 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_WORKFLOW_TRIGGERCreate Trigger. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

boolean
Whether the trigger is active. Defaults to true when omitted.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
required
Integer id or obfuscated public_id of the workflow.
string
Integer database id or obfuscated public_id.
string ("$appointments.appointment_scheduled" | "$calendar_event.contact_registered" | "$community.join" | "$community.group_join" | "$community.topic_join" | "$community.post" | "$community.ban" | "$community.unban" | "$community.post_view" | "$contact.tag_applied" | "$contact.tag_removed" | "$course.complete" | "$course.enroll" | "$course.unenroll" | "$course.lesson_complete" | "$course.lesson_view" | "$course.section_complete" | "$email.bounce" | "$email.click" | "$email.open" | "$email.sent" | "$email.spam_complaint" | "$send_email_step.bounce" | "$send_email_step.click" | "$send_email_step.open" | "$send_email_step.sent" | "$send_email_step.spam_complaint" | "$order.successful_purchase" | "$order.cancelled" | "$order.churned" | "$subscription.upgraded" | "$subscription.downgraded" | "$transaction.renewal_failed" | "$sales.contact_entered_stage" | "$sales.contact_exited_stage" | "$optin" | "$view" | "$message_hub_event.contact_conversation_started" | "$message_hub_event.agent_conversation_started" | "$message_hub_event.contact_responded" | "$message_hub_event.agent_responded" | "$survey.complete")
required
The event key that fires this trigger (e.g. $contact.tag_applied). Must be one of the enumerated keys.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
boolean
Whether to fire for anonymous contacts.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Reason filter for $order.cancelled subscription cancellation triggers.
string
Integer database id or obfuscated public_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_CREATE_WORKSPACE_REFINE_FILTERCreate Refine Filter. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Return projected matches inline. Pass true for ids only; omit for the filter definition alone.
string
required
Identifier used for the workspace id path segment.
object
required
Value for the refine filter request field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DECLINE_COMMUNITIES_SPACES_POSTDecline Post. This can trigger an irreversible external effect. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DECLINE_COMMUNITIES_SPACES_POSTS_COMMENTDecline Comment. This can trigger an irreversible external effect. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_BLOG_POSTDelete Blog Post. This permanently removes the targeted resource. API access tokens need blog:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COMMUNITIES_BANSRemove Ban. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COMMUNITIES_MEMBERSHIPSRemove Membership. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COMMUNITIES_SPACE_GROUPSRemove Space Group. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COMMUNITIES_SPACESRemove Space. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COMMUNITIES_SPACES_POSTSRemove Post. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COMMUNITIES_SPACES_POSTS_COMMENTSRemove Comment. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COMMUNITIES_SPACES_POSTS_COMMENTS_LIKESRemove Comment Like. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COMMUNITIES_SPACES_POSTS_LIKESRemove Post Like. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COMMUNITIES_SPACES_POSTS_VIDEO_EMBEDSRemove Video Embed. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_CONTACTSRemove Contact. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_CONTACTS_APPLIED_TAGSRemove Applied Tag. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_CONTACTS_ENROLL_ACTIONSRemove Enroll Action. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_CONTACTS_EVENTS_NOTESDelete Contact Activity Note. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_CONTACTS_EXPORT_ACTIONSRemove Export Action. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_CONTACTS_RUN_WORKFLOW_ACTIONSRemove Run Workflow Action. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_CONTACTS_TAG_ACTIONSRemove Tag Action. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_CONTACTS_TAGSRemove Tag. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_CONTACTS_UNSUBSCRIBE_ACTIONSRemove Unsubscribe Action. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_CONTACTS_UNSUBSCRIBED_TOPICSResubscribe a Contact to a Topic. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COURSES_LESSON_COMPLETIONSRemove Lesson Completion. This permanently removes the targeted resource. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_COURSES_SECTIONS_PUBLISH_ACTIONSRemove Publish Action. This permanently removes the targeted resource. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_DISCOUNTSRemove Discount. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_EMAILS_ADDRESSESArchive Email Address. This permanently removes the targeted resource. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_EMAILS_BROADCASTDelete Email Broadcast. This permanently removes the targeted resource. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_EMAILS_BROADCASTS_SEND_ACTIONSRemove Send Action. This permanently removes the targeted resource. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_EMAILS_TEMPLATEDelete Email Template. This permanently removes the targeted resource. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_FORMSRemove Form. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_FORMS_FIELDSRemove Field. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_FORMS_FIELD_SETSRemove Field Set. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_FORMS_FIELDS_OPTIONSRemove Option. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_FORMS_SUBMISSIONSRemove Submission. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_FORMS_SUBMISSIONS_ANSWERSRemove Answer. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_FULFILLMENTSRemove Fulfillment. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_FULFILLMENTS_LOCATIONSRemove Location. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_FUNNELS_TAGSPermanently remove a funnel tag. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_IMAGESRemove Image. This permanently removes the targeted resource. API access tokens need media:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_ORDERS_APPLIED_TAGSPermanently remove an applied tag from an order. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_ORDERS_TAGSRemove Tag. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_PAGEDelete Page. This permanently removes the targeted resource. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_PRODUCTS_FROM_PAGERemove Products from Page. This permanently removes the targeted resource. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
array
required
One or more product public IDs (or numeric IDs) to detach.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_PRODUCTS_TAGSRemove Tag. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SALES_OPPORTUNITIESRemove Opportunity. This permanently removes the targeted resource. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SALES_OPPORTUNITIES_NOTESRemove Note. This permanently removes the targeted resource. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SALES_PIPELINESRemove Pipeline. This permanently removes the targeted resource. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SALES_PIPELINES_STAGESRemove Stage. This permanently removes the targeted resource. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SEGMENTSDelete Segment. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SHIPPING_ADDRESSESRemove shipping addresses. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SHIPPING_PACKAGESRemove Package. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SHIPPING_PROFILESRemove Profile. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SHIPPING_RATESRemove Rate. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SHIPPING_RATES_NAMESRemove Name. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_SHIPPING_ZONESRemove Zone. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_STORESRemove Store. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_ENDPOINTSRemove Incoming External Purchase Endpoint. This permanently removes the targeted resource. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_WEBHOOKS_OUTGOING_ENDPOINTSRemove Endpoint. This permanently removes the targeted resource. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_WORKFLOWDelete Workflow. This permanently removes the targeted resource. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_WORKFLOW_STEPDelete Step. This permanently removes the targeted resource. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DELETE_WORKFLOW_TRIGGERDelete Trigger. This permanently removes the targeted resource. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string ("matched" | "unmatched" | "both")
Optional branch to remove. One of matched, unmatched, or both (default).
string
required
Identifier used for the funnel id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DESTROY_FUNNELSDelete an empty Funnel. This permanently removes the targeted resource. API access tokens need funnels:write (or coarse write) permission; funnels with attached workflow triggers also need workflows:write (or coarse write).

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DESTROY_FUNNEL_SPLIT_TEST_STEPDelete a funnel split test step or a selected branch. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string ("left" | "right" | "both")
Optional branch to remove. One of left, right, or both (default).
string
required
Identifier used for the funnel id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DESTROY_REFINE_FILTERDestroy Refine Filter. This permanently removes the targeted resource. ClickFunnels applies Contacts write access to this endpoint regardless of the saved filter class; coarse write also authorizes it.

Input Parameters

string
required
Public id of the RefineFilter to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DISABLE_WORKFLOWDisable Workflow. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DISMISS_REPORTS_COMMUNITIES_SPACES_POSTDismiss Reports on Post. This can trigger an irreversible external effect. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_DISMISS_REPORTS_COMMUNITIES_SPACES_POSTS_COMMENTDismiss Comment Reports. This can trigger an irreversible external effect. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_ENABLE_WORKFLOWEnable Workflow. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GDPR_DESTROY_CONTACTSRedact Contact. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Human-readable name for the saved filter. Only used when save is true. Must be unique within the workspace when provided.
boolean
When 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).
string
required
Natural-language description of the audience or filter to generate.
string
Return projected matches inline. Pass true for ids only; omit for the filter definition alone.
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_ADDRESSES_COUNTRIESGet Country. API access tokens need reference:read or reference:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
The country’s ISO 3166-1 alpha-2 code (e.g. “US”).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_BLOGFetch Blog. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_BLOG_AUTHORFetch Blog Author. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_BLOG_CATEGORYFetch Blog Category. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
array
Expand additional data in the response. Use 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_BLOG_TAGFetch Blog Tag. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIESFetch Community. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_BANSFetch Ban. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_BANS_EXPORT_ACTIONSFetch Ban Export Action. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_BANS_UNBAN_ACTIONSFetch Ban Unban Action. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_MEMBERSHIPSFetch Membership. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_MEMBERSHIPS_ADD_TO_GROUP_ACTIONSFetch Membership Add-To-Group Action. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_MEMBERSHIPS_BAN_ACTIONSFetch Membership Ban Action. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_MEMBERSHIPS_EXPORT_ACTIONSFetch Membership Export Action. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_MEMBERSHIPS_REMOVE_FROM_GROUP_ACTIONSFetch Membership Remove-From-Group Action. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_SPACE_GROUPSFetch Space Group. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_SPACESFetch Space. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_SPACES_POSTSFetch Post. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_SPACES_POSTS_COMMENTSFetch Comment. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COMMUNITIES_SPACES_POSTS_VIDEO_EMBEDSFetch Video Embed. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The saved filter’s id or public_id.
string
Return projected matches inline. Pass true for ids only; omit for the filter definition alone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
array
Expand additional data in the response. Use expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_APPLIED_TAGSFetch Applied Tag. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_BILLING_ADDRESSGet contact billing address. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the contact id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_ENROLL_ACTIONSFetch Enroll Action. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_EVENTSFetch Contact Event. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_EVENTS_NOTESFetch Contact Activity Note. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_EXPORT_ACTIONSFetch Export Action. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_RUN_WORKFLOW_ACTIONSFetch Run Workflow Action. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_SUBSCRIPTION_CHANGESFetch Contact Subscription Change. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_TAG_ACTIONSFetch Tag Action. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_TAGSFetch Tag. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_UNSUBSCRIBE_ACTIONSFetch Unsubscribe Action. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CONTACTS_UNSUBSCRIBED_TOPICSFetch Contact Topic Opt-out. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COURSESFetch Course. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COURSES_ENROLLMENTSFetch Enrollment. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COURSES_LESSON_COMPLETIONSFetch Lesson Completion. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COURSES_LESSONSFetch Lesson. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COURSES_SECTIONSFetch Section. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_COURSES_SECTIONS_PUBLISH_ACTIONSFetch Publish Action. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_CURRENT_USERFetch My User. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_DISCOUNTSFetch Discount. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_DOMAINFetch Domain. API access tokens need sites:read or sites:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_DOWNLOADSFetch Download. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_EMAILS_ADDRESSESGet Email Address. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_EMAILS_BROADCASTFetch Email Broadcast. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_EMAILS_BROADCASTS_SEND_ACTIONSFetch Send Action. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_EMAILS_BROADCAST_STATSFetch Email Broadcast Stats. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the broadcast id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_EMAILS_DOMAINSGet Email Domain. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_EMAILS_SETTINGSGet Email Settings. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_EMAILS_TEMPLATEFetch Email Template. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_EMAILS_TOPICFetch Email Topic. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FORMSFetch Form. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FORMS_FIELDSFetch Field. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FORMS_FIELD_SETSFetch Field Set. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FORMS_FIELDS_OPTIONSFetch Option. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FORMS_SUBMISSIONSFetch Submission. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FORMS_SUBMISSIONS_ANSWERSFetch Answer. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FORM_SUBMISSIONSFetch Form Submission. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FULFILLMENTSFetch Fulfillment. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FULFILLMENTS_LOCATIONSFetch Location. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FUNNEL_CONDITIONAL_SPLIT_STEPFetch Conditional Split Step. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
required
Identifier used for the funnel id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
array
Expand additional data in the response. Use expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FUNNELS_CLONE_ACTIONSFetch Funnel Clone Action. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FUNNEL_SPLIT_TEST_STEPFetch Split Test Step. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
required
Identifier used for the funnel id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FUNNELS_TAGSFetch Tag. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Expand additional data in the response. Use 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.
string
required
Identifier used for the funnel id path segment.
string
End of the stats timerange (ISO 8601 only; any other value is a 422. Send an offset’s + as %2B, since an unencoded + arrives as a space). Defaults to the current time. Values in the future are automatically clamped to now.
string
Start of the stats timerange (ISO 8601 only; any other value is a 422. Send an offset’s + as %2B, since an unencoded + arrives as a space). Defaults to 30 days before timerange_end. If the window between start and end exceeds 90 days, start is automatically clamped to 90 days before end. If start is after end, the window resets to the default 30 days ending at timerange_end. See Timerange parameters (both endpoints) in the Stats Skill for the clamping rules and how to cover longer windows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_FUNNEL_STRUCTUREFetch Funnel Structure. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_IMAGESFetch Image. API access tokens need media:read or media:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_ORDERSFetch Order. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_ORDERS_APPLIED_TAGSFetch Applied Tag. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_ORDERS_INVOICESFetch Invoice. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_ORDERS_TAGSFetch Tag. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_ORDERS_TRANSACTIONSFetch Transaction. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_PAGE_CUSTOM_HTMLFetch Custom HTML Page Body. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
array
Expand additional data in the response. Use 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the page id path segment.
string
End of the stats timerange (ISO 8601 only; any other value is a 422. Send an offset’s + as %2B, since an unencoded + arrives as a space). Defaults to the current time. Values in the future are automatically clamped to now.
string
Start of the stats timerange (ISO 8601 only; any other value is a 422. Send an offset’s + as %2B, since an unencoded + arrives as a space). Defaults to 30 days before timerange_end. If the window between start and end exceeds 90 days, start is automatically clamped to 90 days before end. If start is after end, the window resets to the default 30 days ending at timerange_end. See Timerange parameters (both endpoints) in the Stats Skill for the clamping rules and how to cover longer windows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_PRODUCTSFetch Product. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_PRODUCTS_COLLECTIONSFetch Collection. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_PRODUCTS_PRICESFetch Price. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_PRODUCTS_TAGSFetch Tag. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_PRODUCTS_VARIANTSFetch Variant. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Public id of the RefineFilter (e.g. AbCdEf).
string
Return projected matches inline. Pass true for ids only; omit for the filter definition alone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_RESTOCKFetch Restock. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SALES_OPPORTUNITIESFetch Opportunity. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SALES_OPPORTUNITIES_NOTESFetch Note. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SALES_PIPELINESFetch Pipeline. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SALES_PIPELINES_STAGESFetch Stage. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string
Return matching contacts inline; omit for the audience definition alone. Requires contacts:read. Count is opt-in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SHIPPING_ADDRESSESGet shipping addresses. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SHIPPING_LOCATION_GROUPSFetch Location Group. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SHIPPING_PACKAGESFetch Package. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SHIPPING_PROFILESFetch Profile. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SHIPPING_RATESFetch Rate. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SHIPPING_RATES_NAMESFetch Name. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_SHIPPING_ZONESFetch Zone. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Expand additional data in the response. Use expand[]=field_name to include optional fields (e.g., expand[]=head_code&expand[]=footer_code). See the Expanding guide for available fields and examples.
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_STORESFetch Store. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_TEAMFetch Team. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_THEMESFetch Theme. API access tokens need sites:read or sites:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_USERFetch User. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_ENDPOINTSFetch Incoming External Purchase Endpoint. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_EVENTSFetch Incoming External Purchase Event. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_PRODUCT_MAPPINGSFetch Incoming External Purchase Product Mapping. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WEBHOOKS_OUTGOING_ENDPOINTSFetch Endpoint. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WEBHOOKS_OUTGOING_EVENTSFetch Event. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WORKFLOWFetch Workflow. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WORKFLOW_RUNFetch Run. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WORKFLOW_STEPFetch Step. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the step id path segment.
string
End of the stats timerange (ISO 8601 only; any other value is a 422. Send an offset’s + as %2B, since an unencoded + arrives as a space). Defaults to the current time. Values in the future are automatically clamped to now.
string
Start of the stats timerange (ISO 8601 only; any other value is a 422. Send an offset’s + as %2B, since an unencoded + arrives as a space). Defaults to 30 days before timerange_end. If the window between start and end exceeds 90 days, start is automatically clamped to 90 days before end. If start is after end, the window resets to the default 30 days ending at timerange_end. See Timerange parameters (both endpoints) in the Stats Skill for the clamping rules and how to cover longer windows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WORKFLOW_STRUCTUREFetch Workflow Structure. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WORKFLOW_TRIGGERFetch Trigger. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_GET_WORKSPACESFetch Workspace. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Totals one allow-listed numeric property. Exact; listed in unavailable instead when it cannot finish in time. Not available for every resource.
boolean
How many records match. Exact unless counting a set of more than 100,000 cannot finish in time - see count_capped_at in the response.
object
Simple field matches. The keys the resource’s index accepts - contact: id, email_address, is_active, tag_ids; order: id, contact_id, order_type, billing_status, service_status, live_mode; form_submission: id, page_id, contact_id - plus created_at_after (inclusive) and created_at_before (exclusive, both ISO 8601 only; send an offset’s + as %2B) on every resource, and funnel_id and product_id on order. 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.
object
Breaks the matching set down by one allow-listed property, returning a count per distinct value.
string ("contact" | "order" | "form_submission")
required
The resource to report on.
string
A URL-encoded Refine 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).
string
required
Identifier used for the workspace id path segment.
boolean
The earliest and latest created_at in the matching set. Exact; listed in unavailable instead when it cannot finish in time.
string
The 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_ADDRESSES_COUNTRIESList Countries. API access tokens need reference:read or reference:write permission; the coarse read or write permission also authorizes this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_ADDRESSES_COUNTRIES_REGIONSList Country Regions. API access tokens need reference:read or reference:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
The country’s ISO 3166-1 alpha-2 code (e.g. “US”).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_BLOGS_AUTHORSList Blog Authors. 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the blog id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the blog id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the blog id path segment.
array
Expand additional data in the response. Use 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.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_BLOGS_TAGSList Blog Tags. 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the blog id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the community id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the community id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the community id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the community id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the community id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.
string
required
Identifier used for the space group id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the space id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the post id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the comment id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the post id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the post id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
array
Expand additional data in the response. Use expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
A URL-encoded Refine 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.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.
string
The 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_CONTACTS_APPLIED_TAGSList Applied Tags. 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the contact id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Value for the filter query filter.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the contact id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the contact id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the contact id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_CONTACTS_TAGSList Tags. 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the contact id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
The provider’s filter value.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the course id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
The provider’s filter value.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the course id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the section id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at" | "sort_order")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the course id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at" | "sort_order")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the course id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
The provider’s filter value.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[email_address]=value&filter[verified]=true. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the broadcast id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.
boolean
Set to true to include archived topics in the results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the field set id path segment.
string ("id" | "updated_at" | "sort_order")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
string
required
Identifier used for the form id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
string
required
Identifier used for the field id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at" | "sort_order")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
string
required
Identifier used for the form id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.
string
required
Identifier used for the submission id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at" | "sort_order")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_FUNNEL_CONDITIONAL_SPLIT_STEPSList Conditional Split Steps. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
Pass filter to include the full RefineFilter object in condition.filter for each step.
string
required
Identifier used for the funnel id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
array
Expand additional data in the response. Use expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Source funnel integer ID or public ID
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_FUNNEL_SPLIT_TEST_STEPSList Split Test Steps. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the funnel id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_FUNNELS_TAGSList Tags. 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
A URL-encoded Refine 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.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.
string
The 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_ORDERS_APPLIED_TAGSList Applied Tags. 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the order id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
string
required
Identifier used for the order id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_ORDERS_TAGSList Tags. 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the order id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
array
Expand additional data in the response. Use 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.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the product id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The source price for which to look up allowed upgrade/downgrade targets. Accepts either the integer database id or the obfuscated public_id string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_PRODUCTS_TAGSList Tags. 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the product id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at" | "sort_order")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.
string
required
Identifier used for the opportunity id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the pipeline id path segment.
string ("id" | "updated_at" | "sort_order")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Value for the filter query filter.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Contact ID
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string
required
Identifier used for the profile id path segment.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the zone id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.
string
required
Identifier used for the location group id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by id, provider or live_mode, like this: ?filter[provider]=whop&filter[live_mode]=true. All about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by id, event_type or processing_status, like this: ?filter[event_type]=payment.succeeded&filter[processing_status]=success. All about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Integer ID or obfuscated public ID of the incoming external purchase endpoint.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.
string
required
Integer ID or obfuscated public ID of the incoming external purchase endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_LIST_WEBHOOKS_OUTGOING_EVENT_TYPESList Event Types. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter runs by 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.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Integer id or obfuscated public_id of the workflow.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Integer id or obfuscated public_id of the workflow.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Integer id or obfuscated public_id of the workflow.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
object
Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.
string ("id" | "updated_at")
Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pass 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.
object
Filter by available properties in query params, like this: api/v2/resources?filter[name]=value. Check our Filtering guide for examples and all about filtering here.
integer
Records per page when opting into bounded paging. Omit this and 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.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string
required
Identifier used for the workspace id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Continuation cursor returned as next_cursor by a previous call.
string
required
Identifier used for the team id path segment.
integer
Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.
string ("asc" | "desc")
Sort order of a list response. Use ‘desc’ to reverse the default ‘asc’ (ascending) sort order. Examples in our guides.
string ("id" | "updated_at" | "name")
Sort property of the workspace list. Defaults to id; updated_at and name are also supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Optional override for proration. Accepts 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.
string
required
The id of the subscription line item. Accepts either the integer database id or the obfuscated public_id string returned by line-item endpoints.
string ("now" | "next_renewal")
Optional override for when the change takes effect. When omitted (or 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.
string
required
Target price. Accepts either the integer database id or the obfuscated public_id string returned by the discovery endpoint. The target variant is derived from the price’s variant association.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_PIN_COMMUNITIES_SPACES_POSTPin Post. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Optional override for proration. Accepts 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.
string
required
The id of the subscription line item. Accepts either the integer database id or the obfuscated public_id string returned by line-item endpoints.
string ("now" | "next_renewal")
Optional override for when the change takes effect. When omitted (or 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.
string
required
Target price. Accepts either the integer database id or the obfuscated public_id string returned by the discovery endpoint. The target variant is derived from the price’s variant association.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string
Optional ISO 8601 datetime at which the course should become live. Must be now or in the future — a past datetime is rejected with a 422. Omit or leave blank to publish immediately.
boolean
When 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string
Optional ISO 8601 datetime at which the lesson should become live. Must be now or in the future — a past datetime is rejected. Omit to publish immediately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string
Optional ISO 8601 datetime at which the section should become live. Must be now or in the future — a past datetime is rejected. Omit to publish immediately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string
Defaults to 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.
boolean
Must be 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_REORDER_FORMS_FIELDSReorder Fields. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the field set id path segment.
array
required
An array of field IDs in the desired order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_SET_DEFAULT_THEMESSet Default Theme. API access tokens need sites:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
array
Expand additional data in the response. Use expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UNARCHIVE_PRODUCTSUnarchive a Product. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UNPIN_COMMUNITIES_SPACES_POSTUnpin Post. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_BLOGUpdate Blog. API access tokens need blog:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name of the blog
integer
Theme ID for the blog
string
Default Blog title for SEO
integer
Default sharing image ID
string
Default Blog description for SEO

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_BLOG_POSTUpdate Blog Post. API access tokens need blog:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Title of the post
string
PML (Page Markup Language) builds the rendered post body and replaces its content tree, published version, and editor draft. Because PML supports only part of the ClickFunnels editor, writing it over an existing body can silently drop unsupported editor content. If the post could have been written or edited in the ClickFunnels editor, get explicit user approval before sending this on update; a general update request is insufficient. Omit 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.
array
IDs of tags to associate with the post
array
Expand additional data in the response. Use 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.
integer
Featured image ID. When importing an article, its images need rehosting first: see Rehost source images during a migration and the image caveat.
string
SEO page title
array
IDs of authors to associate with the post
string ("draft" | "public" | "members_only" | "scheduled")
Visibility status. One of draft, public, members_only, or scheduled. See Two gotchas worth knowing in the Blogs Skill.
array
IDs of categories to associate with the post
string
Date and time to publish the post. Required when visibility is scheduled. See Publish separately in the Import External Blog Post Skill.
string
Short summary of the blog post
string
SEO page description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_COMMUNITIESUpdate Community. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Community Name
string
Status of the community (e.g. live, draft)
boolean
Make this Community Private?
string
Seo Title
boolean
Invite Only?
string
Upgrade URL
boolean
Enable White Label
string
Current Path
integer
Logo Image ID
string
Notification settings (e.g. all, essential, off)
boolean
Seo Indexable?
string
Seo Description
integer
Social Image ID
boolean
Anyone Can Invite?
boolean
Enable Block List?
boolean
Send Digest Email?
boolean
Allow Public Sign-Up?
boolean
Send Membership Email?
boolean
Require Post Approvals?
boolean
Require Comment Approvals?

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_COMMUNITIES_MEMBERSHIPSUpdate Membership. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
boolean
Whether this member should have moderator privileges
array
Array of Space public IDs the member should belong to. The membership form syncs the member’s Space memberships to exactly this list — Spaces not in the list are removed, Spaces in the list are added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_COMMUNITIES_SPACE_GROUPSUpdate Space Group. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name
string
Emoji icon for the group
integer
Access level (0 = open, 1 = private, 2 = secret)
boolean
Always On
boolean
Only show joined Topics
integer
Group type (integer enum)
integer
Sort order within the community
string
Description
string
Upgrade URL
string
Current Path
integer
Card Image ID
string
Approval Terms
boolean
Automatically add members to new Topics within this Group
boolean
Require approvals for posts in this Group?
boolean
Require approvals for comments in this Group?
boolean
Hide from non-members
boolean
Override community-level post approval setting for this group
boolean
Override community-level comment approval setting for this group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_COMMUNITIES_SPACESUpdate Space. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name
string
Emoji icon for the space
integer
Access level (0 = open, 1 = private, 2 = secret)
boolean
Always On
string
Seo Title
integer
Sort order within the space group
string
Default tab shown when viewing the space
string
Upgrade URL
string
Current Path
string
Layout style for the space
integer
Card Image ID
string
Seo Description
integer
Social Image ID
boolean
Whether members can post in this space
boolean
Whether posts can have titles
string
Default sort order for posts
boolean
Whether posts can have cover images
Whether to hide this space from the featured spaces list
boolean
Whether members can invite others to this space
string
Label for pinned posts section
string
Default sort order for members
string
Default sort order for comments

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_COMMUNITIES_SPACES_POSTSUpdate Post. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Post body as rich HTML
string
Post title
integer
Cover image ID
boolean
Whether to pin the post at the top of the space
string
Current path (used for tracking purposes)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_COMMUNITIES_SPACES_POSTS_COMMENTSUpdate Comment. API access tokens need community:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Comment body as rich HTML
boolean
When true, suppresses email/push notifications for this comment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_CONTACTSUpdate Contact. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Facebook URL
array
Contact Tag IDs. Any valid array, empty or with valid tags will overwrite existing values. To avoid losing existing tags first use the Fetch Contact endpoint, then be sure to include the existing tags in your payload along with any new addition(s).
array
Expand additional data in the response. Use expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.
string
Last name
string
The human-readable time zone, usually set dynamically by the app for the contact, for example, during opt-in. Read more about time zones and how to map them back to the TZ standard in our Time Zones guide..
string
First name
string
Twitter URL
string
Website URL
string
LinkedIn URL
string
Phone number
string
Email address
string
Instagram URL
object
Custom attributes are usually added in ClickFunnels to a contact when they submit forms that contain custom contact attributes. Here you can directly create them during contact modification. Custom attributes are provided as key-value pairs: A key that does not exist, will create a new custom contact attribute. A key that already exists, will update the value of an existing custom contact attribute. Empty or null values, will set the custom attribute values to empty strings. A key that has special characters or spaces will be automatically converted to 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_CONTACTS_BILLING_ADDRESSUpdate contact billing address. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
City
string
State code or full region name for the country; unknown values return 422
string
required
Identifier used for the contact id path segment.
string
Street line 1
string
Street line 2
string
Postal code, at most 10 characters
string
ISO2 country code; unknown values return 422

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string
Required nonblank text on creation; no length cap.
string
Optional ISO 8601 timestamp. Defaults to server time on creation; omission on update preserves its occurrence time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_CONTACTS_TAGSUpdate Tag. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Tag Name
string
Tag Color

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_COURSESUpdate Course. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Title
integer
The ID of an Image to show on the storefront of the main course page
string
Description
boolean
Show In Customer Center?
boolean
Redirect To Full Course

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_COURSES_ENROLLMENTSUpdate an enrollment’s suspension status and reason. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
boolean
Suspended
string
Suspension Reason

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_COURSES_LESSONSUpdate Lesson. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Description
string
Title
string
Public ID of an image in the workspace to use as the lesson image.
string
Markdown lesson content. This is the primary content field for the lesson body. It is Markdown, not PML. See Lessons in the Courses Skill.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_COURSES_SECTIONSUpdate Section. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Title
string
Description
integer
Blocker lesson
integer
Blocker section
integer
Days until drip access
boolean
Current Path

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_DISCOUNTSUpdate Discount. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Letters, numbers and hyphens only. Uppercased on save; must be unique within the workspace.
string
Value for the name request field.
string
Value for the amount request field.
boolean
Virtual switch over 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”.
string
Value for the percent request field.
string
ISO currency code. Locked once the discount has been applied to an order.
string ("all_products" | "specific_products" | "specific_variants" | "specific_collections")
Value for the applies to request field.
string
Value for the apply from request field.
string
Schedule a future end date. Must be after apply_from; a past date returns 422. To expire a live discount now, use expired: true instead.
array
Value for the product ids request field.
array
Value for the variant ids request field.
string ("code" | "automatic" | "sale")
code is a redeemable coupon code. automatic and sale are deprecated.
string ("percentage" | "fixed" | "shipping" | "bogo")
Value for the discount method request field.
boolean
Value for the limit 1 per customer request field.
boolean
Value for the require minimum spend request field.
array
Value for the products collection ids request field.
integer
Value for the discounts per redemption request field.
integer
Minimum order subtotal, in whole currency units rather than cents - 50 on a usd discount means $50.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_EMAILS_ADDRESSESUpdate Email Address. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
The from-name shown to recipients (e.g. “Acme Support”). Required when creating.
string
Optional internal label.
string
Selects among ClickFunnels’ shared sending domains only; normally omit it to get the default (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.
string
The local part before the @ (e.g. “hello” for hello@yourdomain.com). Required when creating.
integer
Numeric 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_EMAILS_BROADCASTUpdate Email Broadcast. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Internal name for the broadcast
string
Scheduled send date
string
Email subject line seen by recipients
array
Omit to preserve variant B, send one entry to replace B, or send an empty array to remove B while split_test is false. The top-level subject and preheadline remain variant A.
string
Contact filter for the broadcast audience. Accepts any of three forms: the numeric id or the public id (string) of a saved contact filter (Refine::StoredFilter) in this workspace, or a serialized contact filter. The supplied filter is copied onto the broadcast — the broadcast points at its own copy, so later edits to (or deletion of) the saved filter never change this broadcast’s audience. Saved contact filters can be created/listed via the Refine Filters Skill. See Applying filters to email broadcasts.
string
HTML email body
string
Plain text email body
string
Time zone for scheduling
array
Topic IDs to associate
string
Sender email address. Must be a verified email address that belongs to the workspace.
boolean
Enable or disable the subject-line split test. Disabling preserves variant B and the stored test settings for later editing. Must be a JSON boolean - string spellings such as "true" return 422.
string
An optional external identifier for your own tracking
string
Preview text shown in email clients before opening. Maximum 150 characters.
integer
Numeric id of an existing email template in this workspace to point this draft broadcast at (swaps the referenced template). Takes precedence over an inline html_body/text_body. Only draft broadcasts can be updated; an unknown id returns 422.
boolean
Smart Sending. When true the broadcast is delivered gradually across a window rather than all at once, which protects deliverability. A broadcast is created with this on, so send false to deliver the whole audience in one go. Above 5,000 recipients Smart Sending is mandatory: sending false is accepted and may be stored as true. The send batches at that size regardless of the stored value.
string
Reply-to email address. Must be a verified address in the workspace if provided.
string
Scheduled send time in HH:MM:SS format
number
How many smart_sending_units the delivery window spans, for example 2 with hour. Must be between 0.5 and 100, and must be sent together with smart_sending_unit. Send both as null to go back to sizing the window from the audience.
string ("hour" | "day")
The unit of the Smart Sending delivery window. Must be sent together with smart_sending_time. Send both as null to go back to sizing the window from the audience.
integer
Whole hours to wait before choosing the subject-line winner. Omit to preserve the stored value.
integer
Whole-number share of the audience used for the test sends. Omit to preserve the stored value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_EMAILS_SETTINGSUpdate Email Settings. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Business/sender name shown on email broadcasts
object
The marketing (business) address. This workspace-wide prerequisite must be complete before creating a broadcast or workflow send-email step, and before sending a broadcast.
string
required
Identifier used for the workspace id path segment.
boolean
Hide ClickFunnels branding in the email footer
Alignment of the email footer. Any other value is rejected with a 422.
Custom unsubscribe footer text
boolean
Render the marketing address on a single line
integer
An Emails::Address id used as the from address for system emails
integer
An Emails::Address id used as the from address for marketing emails
integer
An Emails::Address id used as the reply-to address for system emails
integer
An Emails::Address id used as the reply-to address for marketing emails

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_EMAILS_TEMPLATEUpdate Email Template. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Internal name for the template
string
Default email subject line
string
HTML email body
string
Plain text email body
integer
ID of a sending address that belongs to this workspace. A foreign address is rejected with 422.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_EMAILS_TOPICUpdate Email Topic. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Topic name
string
Topic description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FORMSUpdate Form. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FORMS_FIELDSUpdate Field. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Key
string
Label
boolean
Hidden
string
Field Type
boolean
Allow Multiple

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FORMS_FIELD_SETSUpdate Field Set. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Title

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FORMS_FIELDS_OPTIONSUpdate Option. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Label

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FORMS_SUBMISSIONSUpdate Submission. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
integer
Contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FORMS_SUBMISSIONS_ANSWERSUpdate Answer. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Entry
string
Field
integer
ID of a record from the Forms::Fields::Option API.
array
Fields Options

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FULFILLMENTSUpdate Fulfillment. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Tracking URL
string
Tracking Code
boolean
Send an email to the customer when the fulfillment is updated. Will use workspace default behavior if left unset
string
Shipping Provider

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string
Location name
object
Value for the address request field.
boolean
Indicates if the location is archived
string
Address name
boolean
Indicates a location managed by an external integration. Only to be used for requests made with Oauth 2.0 access tokens. External app locations do not need to provide an address.
string
Phone number
string
Email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FUNNEL_CONDITIONAL_SPLIT_STEPUpdate Conditional Split Step. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
array
Value for the branches request field.
object
Value for the condition request field.
string
required
Identifier used for the funnel id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FUNNELSUpdate Funnel. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name of the Funnel
array
Replace the funnel’s tags with numeric IDs from its workspace. An empty array clears tags; null is ignored.
array
Expand additional data in the response. Use expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.
integer
The ID of the domain to associate with this funnel. Set to null to remove the domain association. Use the Domains API to look up available domain IDs.
string
Custom code to inject into the funnel’s <head> section. Content should be wrapped in appropriate HTML tags such as <script>, <link>, <meta>, or <style>. Set to null to clear existing code.
boolean
Controls test versus live payment processing, not page visibility or publication. True enables live payments; false keeps test mode. Boolean values and the strings ‘true’/‘false’ are accepted by the update operation; null, empty and other values leave the current mode unchanged. Use updatePages for intentional live page content writes.
Custom code to inject before the closing </body> tag. JavaScript should be wrapped in <script> tags. Set to null to clear existing code.
string
The funnel URL path. It is normalized to lowercase with a leading slash. Blank, root, reserved, and occupied paths are rejected.
string ("append" | "replace")
How to handle head_code. ‘append’ adds to existing code (default), ‘replace’ overwrites.
string
The ID of an image in the funnel’s workspace. A positive numeric ID or digit-only string is accepted; null clears the favicon. Update only.
How to handle footer_code. ‘append’ adds to existing code (default), ‘replace’ overwrites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FUNNEL_SPLIT_TEST_STEPUpdate Split Test Step. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
array
required
Value for the variants request field.
string
required
Identifier used for the funnel id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_FUNNELS_TAGSUpdate Tag. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name of the funnel tag
string
The color of the funnel tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_IMAGESUpdate Image. API access tokens need media:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Image name
string
Image alt attribute
string
The source URL of the image that you want to upload. Not required on Update when not needed to re-upload the image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_ORDERSUpdate Order. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Your internal note about the order. This will be visible in ClickFunnels admin orders-related sections.
string
(External subscription orders only) Date the subscription churned.
string
Set the next billing-cycle start for a Payments AI subscription in 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.
string
(External subscription orders only) Date the order was canceled.
string
(External subscription orders only) Who canceled the order.
string
(External orders only) An external ID, e.g., a payment provider’s ID or an ID managed by the client internally.
string
(External subscription orders only) Date the subscription was activated.
string
Set the trial end for a Payments AI or Stripe subscription as an absolute RFC 3339 timestamp. A later value extends the trial and an earlier future value shortens it. The order normally has 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.
string
(External subscription orders only) The reason code for the cancelation. External orders accept the same cancelation reasons as Stripe: customer_service, low_quality, missing_features, other, switched_service, too_complex, too_expensive, unused
string
(External orders only) The billing status reflects the status of the invoice of an order. For external orders, the billing status can be one of: pending, paid, unpaid, voided and refunded.
string
(External subscription orders only) Date of the next scheduled charge.
string
(External orders only) The service status reflects the activity state of the order. 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.
string
(External subscription orders only) A free-text description of the cancellation reason.
string
(External orders only) The city of the billing address.
string
(External orders only) The city of the shipping address.
string
(External orders only) The region of the billing address, like state or province.
string
(External orders only) The billing address country.
string
(External orders only) The region of the shipping address, like state or province.
string
(External orders only) The country of the shipping address.
string
(External orders only) The main street information of the billing address, including the street name and number.
string
(External orders only) Additional street information of the billing address, like entrance information and apartment numbers.
string
(External orders only) The last name of the recipient’s shipping address.
string
(External orders only) Billing address postal (ZIP) code.
string
(External orders only) The first name of the recipient’s shipping address.
string
(External orders only) The main street information of the shipping address, including the street name and number.
string
(External orders only) Additional street information for the shipping address, like entrance information and apartment numbers.
string
(External orders only) The postal code of the shipping address.
string
(External orders only) The phone number of the recipient’s shipping address.
string
(External orders only) The organization name of the recipient’s shipping address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_ORDERS_INVOICESUpdate External Invoice. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
The date the invoice is due.
string ("unpaid" | "paid" | "voided" | "refunded" | "disputed" | "past-due")
The billing status of the invoice. For external orders, valid statuses are: 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.
string
The date the invoice was paid. Required when changing status to paid.
string
The date the invoice was issued.
string
The unique identifier for this invoice in your external system. This ID allows you to correlate ClickFunnels invoices with records in your payment processor.
string
A sequential number for bookkeeping purposes.
string
Invoiced shipping amount. Cannot be negative.
array
Update existing line items. Only line items with an id will be processed; new line items (without id) are ignored during updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_ORDERS_TAGSUpdate Tag. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Tag Name
string
Tag Color

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_PAGESUpdate Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Page name of the editable page element.
array
Expand additional data in the response. Use 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.
object
Optional funnel mutation block. On update, only show_page_step_id is supported — swap the page onto an existing show page step.
string
Valid PML (Page Markup Language) replacing live visual content; this is not saved-draft promotion and may not delete an existing draft blob. Because PML supports only part of the ClickFunnels editor, round-tripping an editor page can silently drop unsupported content. If the page could have been created or edited in the ClickFunnels editor, get explicit user approval before sending this; a general update or publish request is insufficient. Internal pages only; external pages return 422. Mid-construct markup (an unclosed tag, attribute, comment, <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.
string
Custom code to inject into the page’s <head> section. Internal pages only — returns 422 on external pages. Set to null to clear existing code.
boolean
Whether search engines should index this page. An indexable funnel step page is listed in its domain’s sitemap.xml. Internal and custom HTML pages — returns 422 on external pages.
string
Custom title for search engine results. Internal pages only — returns 422 on external and custom HTML pages.
string
Raw CSS to apply at the page level (no <style> wrapper). Maps to the CSS tab in the page editor’s Code Editor panel. Internal pages only — returns 422 on external pages. Set to null to clear existing CSS.
integer
Reposition the page within its funnel. Zero-based. 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.
string
Replace the entire HTML body of a custom HTML page (max 2MB). An empty or whitespace-only string is rejected with a 422 (omit the field to leave the body unchanged). The stored HTML is served verbatim at the page’s URL; the edge cache is purged on write. Custom HTML pages only — returns 422 on other page types. Read the current HTML via GET /pages/{id}/custom_html.
string
A short description of the page (max 1000 characters).
Custom code to inject before the closing </body> tag. Internal pages only — returns 422 on external pages. Set to null to clear existing code.
string
Move the page’s URL path (e.g. /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.
string
Update the external URL for an SDK page. External pages only — returns 422 on internal pages. The SDK token is preserved across URL updates. To move external pages to a new origin, see the Migrate an External Page Domain Skill.
string ("append" | "replace")
How to handle head_code. ‘append’ adds to existing code (default), ‘replace’ overwrites. Internal pages only.
object
Optional. Mutates the show_page_step that this page is attached to. Only valid when the page is part of a funnel — passing 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.
boolean
Block AI answer engines (OAI-SearchBot, PerplexityBot and others) from indexing this page and citing it in answers. Internal and custom HTML pages — returns 422 on external pages. See Crawler access (AI opt-out) in the Pages Skill for coverage limits.
string ("append" | "replace")
How to handle custom_css. ‘append’ adds to existing CSS (default), ‘replace’ overwrites. Internal pages only.
string
Custom meta description for search engine results. Internal pages only — returns 422 on external and custom HTML pages.
boolean
Block AI training crawlers (GPTBot, ClaudeBot, Google-Extended and others) from using this page’s content to train models. Internal and custom HTML pages — returns 422 on external pages. See Crawler access (AI opt-out) in the Pages Skill for coverage limits.
How to handle footer_code. ‘append’ adds to existing code (default), ‘replace’ overwrites. Internal pages only.
boolean
Block AI assistants (ChatGPT-User, Claude-User and others) from opening this page when a person asks them to. Internal and custom HTML pages — returns 422 on external pages. See Crawler access (AI opt-out) in the Pages Skill for coverage limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_PRODUCTSUpdate Product. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Product name
array
Any valid array, empty or with valid tag ids will overwrite existing values. To avoid losing existing tags first use the Fetch Product endpoint, then be sure to include the existing tags in your payload along with any new addition(s)
array
Images
array
Price IDs
string
A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters.
array
Variant IDs
string
Current Path
string
SEO image
boolean
Commissionable
string
A clear SEO description, at least two sentences long. Longer is better, but max is 160 characters. You will find the actual user-facing description on the default variant of the product (see the Products::Variant resource).
boolean
Visible in Store
string
Redirect funnel
array
The properties of the product’s variants. e.g. ‘Size’, ‘Color’ etc.
string
Cancellation Funnel Url
boolean
Visible in Customer Center

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_PRODUCTS_COLLECTIONSUpdate Collection. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name of the products collection
string
Collection image
string
Title of the collection for SEO purposes
string
Description of the collection
array
Array of product IDs in the collection. Updating with invalid or non-workspace product IDs will result in an error. If IDs from existing products in the collection are left out, they will be removed from the collection. You can also remove all the products from a collection by providing an empty array.
string ("manually" | "name_asc" | "name_desc" | "price_desc" | "price_asc" | "added_at_desc" | "added_at_asc" | "created_at_desc" | "created_at_asc")
Method used to sort the products in the collection
string
Type of the collection (manual or automatic)
string
Description of the collection for SEO purposes
string
Image for social sharing
boolean
Whether the collection is visible in the online store

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_PRODUCTS_PRICESUpdate Price. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Key
string
Cost
string
Name
string
Amount
boolean
Visible
boolean
Archived
string
Currency. Ignored on write — a price always takes its workspace’s currency, so sending a different one has no effect.
integer
Amount of payments. Only used by a payment_plan price.
string ("days" | "weeks" | "months" | "quarters" | "years")
Billing period unit — note the values are plural (‘months’, not ‘month’). Only used by a subscription or payment_plan price.
boolean
Customer can cancel
string ("one_time" | "subscription" | "payment_plan")
Defaults to ‘one_time’ if left blank
boolean
Legacy setting with no effect: no checkout, customer portal or API plan change reads it. GET /products/prices/{price_id}/change_options lists the upgrades and downgrades the API allows from this price.
string
Setup amount
string
Amount charged for the trial. Leave at ‘0.00’ for a free trial, or set it above 0 for a paid one. Only applies when trial_interval and trial_duration are both set.
integer
How many intervals between charges — interval ‘months’ with interval_count 3 bills every 3 months. Only used by a subscription or payment_plan price.
boolean
Legacy setting with no effect: no checkout, customer portal or API plan change reads it. GET /products/prices/{price_id}/change_options lists the upgrades and downgrades the API allows from this price.
integer
Length of the trial, in trial_interval units. A positive value sent alone is stored but inactive until trial_interval is added. Clearing this field removes the trial configuration.
string ("days" | "weeks" | "months" | "quarters" | "years")
Trial period unit — same plural values as interval. An active recurring trial needs this field and a positive trial_duration. Adding it to a price with a stored trial_duration activates the trial. Clearing only this field leaves the duration stored but inactive. Trial fields are cleared on a one_time price.
boolean
Customer can reactivate
string
Compare at amount

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_PRODUCTS_TAGSUpdate Tag. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name of the product tag
string
The color of the product tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_PRODUCTS_VARIANTSUpdate Variant. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
SKU
string
Variant name
number
Width
number
Height
number
Length
number
Weight
string
Taxable
boolean
Is visible
boolean
Archived
array
Digital-asset access. The IDs of workspace Assets a purchase of this variant should grant access to. Pair with has_access_to_all_valid_assets (set it false to grant only these). This replaces the current set.
array
The images for the variant.
string
The description of the variant. The description of the default variant is the user-facing description of the Product.
string
Weight unit
string
Product type
boolean
Track Quantity
string
Dimensions unit
string
Tax category ID
array
The property values of the Variant. e.g. ‘Large’, ‘Red’ etc.
boolean
Out of stock sales
boolean
Fulfillment required
string
Country of manufacture
array
The fulfillment locations for the variant.
array
Course access to grant. Each entry links a Course by 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.
boolean
All-or-nothing digital-asset access. When true, a purchase grants access to every valid Asset. Set false and pass asset_ids to grant only specific ones.
array
Community access to grant. Each entry links a Community Space Group by 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_REFINE_FILTERUpdate Refine Filter. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Public id of the RefineFilter to update.
string
Return projected matches inline. Pass true for ids only; omit for the filter definition alone.
object
required
Value for the refine filter request field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SALES_OPPORTUNITIESUpdate Opportunity. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name
number
The potential value of this opportunity in the default currency of the workspace
string
Close date
integer
The ID of the Team Membership to assign the Opportunity to. An Opportunity can be assigned to any Team member since they have access to all your workspaces. You can get a list of available Memberships and their id via the Team resource’s memberships property. If the opportunity is already assigned to a team member, the assignee will be updated. You can unset the assignee by passing a null value for assignee_id.
integer
Pipeline Stage ID
integer
Primary Contact ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SALES_OPPORTUNITIES_NOTESUpdate Note. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Content
integer
The ID of the Team-Membership that created the note. When creating notes via the API, this defaults to the ClickFunnels API default User’s Membership ID. You can retrieve a list of available Memberships and their id via the Team resource’s memberships property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SALES_PIPELINESUpdate Pipeline. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Pipeline name
array
The stages of the pipeline. The stages are ordered by the position attribute.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SALES_PIPELINES_STAGESUpdate Stage. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Stage name
integer
The position of the stage in the pipeline. The stages are ordered by the sort order attribute, starting at zero. If not provided, the stage will be added at the end of the pipeline. If provided, the stage will be inserted at the specified position, and the sort order of the subsequent stages will be incremented by one.
number
Close probability of the opportunities in this stage

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SEGMENTSUpdate Segment. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Return matching contacts inline; omit for the audience definition alone. Requires contacts:read. Count is opt-in.
object
required
Value for the segment request field.
string
Return projected matches inline. Pass true for ids only; omit for the filter definition alone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SHIPPING_ADDRESSESUpdate shipping addresses. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
object
Partial street update. IDs, owner and checkout verification fields are read-only and ignored if supplied. The resulting address must remain complete. Changing country without region clears the old region.
boolean
Set true to select this entry. False on the current default returns 422; select another entry instead.
string
Last name
string
First name
string
Phone number
string
Organization name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SHIPPING_PACKAGESUpdate Package. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name
number
Width
number
Height
number
Length
number
Weight
string ("fedex" | "ups" | "usps")
Carrier
string ("lb" | "kg" | "g" | "oz")
Weight Unit
string
Empty Weight
string ("box" | "envelope" | "soft_package")
Package Type
string
Distance Unit
boolean
Default Package

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SHIPPING_PROFILESUpdate Profile. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name
array
Variant IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SHIPPING_RATESUpdate Rate. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Price
string
Provider Name
integer
Rate name ID
string
Price Currency
string
Live Rates Provider

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SHIPPING_RATES_NAMESUpdate Name. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Rate Name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SHIPPING_ZONESUpdate Zone. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name
array
Region IDs
array
Country IDs
string
Zone
boolean
Includes Rest of the World

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_SITEUpdate Site. API access tokens need sites:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Name of the site.
array
Expand additional data in the response. Use expand[]=field_name to include optional fields (e.g., expand[]=head_code&expand[]=footer_code). See the Expanding guide for available fields and examples.
string
Custom code to inject into the site’s <head> section. Content should be wrapped in appropriate HTML tags such as <script>, <link>, <meta>, or <style>. Set to null to clear existing code.
Custom code to inject before the closing </body> tag. JavaScript should be wrapped in <script> tags. Set to null to clear existing code.
string
Set which page is served at the site’s root path (”/”). Pass the page’s public id, or an empty string to clear the homepage. Important: a page cannot become the homepage by setting its own path to ”/” — this parameter is the only way to designate a page as the homepage. The theme_id, blog_theme_id, and store_theme_id fields are read-only in this endpoint; to change the default theme, use the theme set_default action.
string
required
Identifier used for the workspace id path segment.
string ("append" | "replace")
How to handle head_code. ‘append’ adds to existing code (default), ‘replace’ overwrites.
How to handle footer_code. ‘append’ adds to existing code (default), ‘replace’ overwrites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_STORESUpdate Store. API access tokens need store:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Name
string ("draft" | "published")
Store Status
string
SEO title
string
Current path
boolean
SEO Indexable
string
SEO description
string
Social image

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string
The name of your Team
string ("en" | "ja" | "pt")
The main language used to create a new website.
string
The human-readable time zone set manually by a ClickFunnels user or dynamically by the app. Read more about time zones and how to map them back to the TZ standard in our Time Zones guide..

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_THEMESUpdate Theme. API access tokens need sites:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
A custom name to override the theme name
object
Set which page renders each template type. Pass a partial object — only the entries you include are updated; omitted keys are left unchanged. Keys are template-type names (e.g. home_template_page, not_found_template_page); values are a page’s public id, or an empty string to clear that slot. Unknown template-type names are rejected with a 422 error.
integer
The style that will be applied to the theme

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier used for the id path segment.
string
Human-readable endpoint name.
string
Whop endpoints only: the ws_ signing secret Whop revealed when you created the webhook in your Whop dashboard, pointed at this endpoint’s url. Whop does not let a user OAuth token manage webhooks, so registration is manual and this is how the secret is supplied. Ignored when blank or on other providers, and must start with ws_. The secret is never returned by any read.
boolean
Whether ClickFunnels suppresses its order system emails for purchases received by this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_PRODUCT_MAPPINGSUpdate Incoming External Purchase Product Mapping. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Provider product, plan, or SKU identifier. For Whop, use the plan ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_WEBHOOKS_OUTGOING_ENDPOINTSUpdate Endpoint. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
The URL that ClickFunnels event webhooks will be sent to.
string
The custom name for the webhook endpoint.
array
The pages scope of the webhook, i.e., the endpoint will only subscribe to events triggered by users from the pages with the given IDs. If not configured initially (equalling null) or empty, subscribes to events fired from any page in the workspace. Updating the array will override existing values. To remove all page_ids pass an empty array or null.
array
The funnel scope of the webhook, i.e., the endpoint will only subscribe to events triggered by users from the funnels with the given IDs. If not configured initially (equalling null) or empty, subscribes to events fired from any funnel in the workspace. Updating the array will override existing values. To remove all funnel_ids pass an empty array or null.
array
The event type keys to which the webhook endpoint subscribes. Each value is a dotted or slashed string key (e.g. 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_WORKFLOWUpdate Workflow. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
New name for the workflow.
boolean
Set to true to archive the workflow, false to unarchive.
string ("asynchronous" | "synchronous" | "one_time")
How the workflow handles a contact who triggers it again: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_WORKFLOW_STEPUpdate Step. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Value for the name request field.
string
Value for the branch request field.
integer
Value for the position request field.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
object
One-key settings map; the key must match the step’s existing type. A 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_WORKFLOW_TRIGGERUpdate Trigger. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
boolean
Value for the active request field.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string ("$appointments.appointment_scheduled" | "$calendar_event.contact_registered" | "$community.join" | "$community.group_join" | "$community.topic_join" | "$community.post" | "$community.ban" | "$community.unban" | "$community.post_view" | "$contact.tag_applied" | "$contact.tag_removed" | "$course.complete" | "$course.enroll" | "$course.unenroll" | "$course.lesson_complete" | "$course.lesson_view" | "$course.section_complete" | "$email.bounce" | "$email.click" | "$email.open" | "$email.sent" | "$email.spam_complaint" | "$send_email_step.bounce" | "$send_email_step.click" | "$send_email_step.open" | "$send_email_step.sent" | "$send_email_step.spam_complaint" | "$order.successful_purchase" | "$order.cancelled" | "$order.churned" | "$subscription.upgraded" | "$subscription.downgraded" | "$transaction.renewal_failed" | "$sales.contact_entered_stage" | "$sales.contact_exited_stage" | "$optin" | "$view" | "$message_hub_event.contact_conversation_started" | "$message_hub_event.agent_conversation_started" | "$message_hub_event.contact_responded" | "$message_hub_event.agent_responded" | "$survey.complete")
New event key. Must be one of the enumerated keys; an invalid key returns 422.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
boolean
Value for the allow anonymous contacts request field.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Integer database id or obfuscated public_id.
string
Value for the subscription cancelation reason request field.
string
Integer database id or obfuscated public_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPDATE_WORKSPACESUpdate Workspace. API access tokens need account:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.
string
Workspace Name
string
The subdomain can currently only be changed in rare cases right after the creation of your new workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_UPSERT_CONTACTSUpsert a Contact. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
Facebook URL
array
Contact Tag IDs. Any valid array, empty or with valid tags will overwrite existing values. To avoid losing existing tags first use the Fetch Contact endpoint, then be sure to include the existing tags in your payload along with any new addition(s).
array
Expand additional data in the response. Use expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.
string
Last name
string
The human-readable time zone, usually set dynamically by the app for the contact, for example, during opt-in. Read more about time zones and how to map them back to the TZ standard in our Time Zones guide..
string
First name
string
Twitter URL
string
Website URL
string
LinkedIn URL
string
Phone number
string
required
Identifier used for the workspace id path segment.
string
Email address
string
Instagram URL
object
Custom attributes are usually added in ClickFunnels to a contact when they submit forms that contain custom contact attributes. Here you can directly create them during contact modification. Custom attributes are provided as key-value pairs: A key that does not exist, will create a new custom contact attribute. A key that already exists, will update the value of an existing custom contact attribute. Empty or null values, will set the custom attribute values to empty strings. A key that has special characters or spaces will be automatically converted to 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKFUNNELS_VERIFY_EMAILS_DOMAINSVerify Email Domain. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

Input Parameters

string
required
Identifier used for the id path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not