---
canonical_url: "https://docs.composio.dev/toolkits/clickfunnels"
markdown_url: "https://docs.composio.dev/toolkits/clickfunnels.md"
product: "platform"
version: null
last_updated: null
---

# ClickFunnels 2.0

Manage funnels, contacts, workflows, commerce, sites, courses, email, and other ClickFunnels 2.0 workspace resources.

- **Category:** marketing automation
- **Auth:** OAUTH2, API_KEY
- **Composio-managed OAuth available?** No
- **Tools:** 476
- **Triggers:** 0
- **Slug:** `CLICKFUNNELS`
- **Version:** 00000000_00

## Tools

### Abandon Invoice

**Slug:** `CLICKFUNNELS_ABANDON_ORDERS_INVOICES`

Abandon 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Approve Post

**Slug:** `CLICKFUNNELS_APPROVE_COMMUNITIES_SPACES_POST`

Approve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Approve Comment

**Slug:** `CLICKFUNNELS_APPROVE_COMMUNITIES_SPACES_POSTS_COMMENT`

Approve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Email Topic

**Slug:** `CLICKFUNNELS_ARCHIVE_EMAILS_TOPIC`

Archive 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive a Funnel

**Slug:** `CLICKFUNNELS_ARCHIVE_FUNNELS`

Archive a Funnel. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `expand__` | array | No | Expand additional data in the response. Use `expand[]=field_name` to include optional fields. Available fields: head_code, footer_code. See the [Expanding guide](https://developers.myclickfunnels.com/docs/expand) for examples. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive a Product

**Slug:** `CLICKFUNNELS_ARCHIVE_PRODUCTS`

Archive a Product. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel a Fulfillment

**Slug:** `CLICKFUNNELS_CANCEL_FULFILLMENTS`

Cancel 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Order

**Slug:** `CLICKFUNNELS_CANCEL_ORDER`

Cancel 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `canceled_by` | string | No | Attribution for who or what requested the cancelation. It is persisted on the order and recorded in its audit timeline. Defaults to `API`. |
| `cancel_reason` | string | No | 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` |
| `effective_date` | string | No | 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](https://accounts.myclickfunnels.com/.well-known/orders/skill.md#cancel-a-subscription) in the [Orders Skill](https://accounts.myclickfunnels.com/.well-known/orders/skill.md) for how the period-end and immediate cancels differ and which fields settle later. |
| `voidable_invoices` | array | No | 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. |
| `cancel_description` | string | No | A free-text description of the cancellation reason. |
| `cancelation_proration` | boolean | No | Whether to prorate the cancelation. Defaults to `false`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Blog Post

**Slug:** `CLICKFUNNELS_CREATE_BLOG_POST`

Create Blog Post. API access tokens need blog:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Title of the post |
| `markup` | string | No | 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](https://accounts.myclickfunnels.com/.well-known/page-markup/skill.md) for the DSL, approval guardrail, and normalization rules. |
| `blog_id` | string | Yes | Identifier used for the blog id path segment. |
| `tag_ids` | array | No | IDs of tags to associate with the post |
| `expand__` | array | No | 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](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |
| `image_id` | integer | No | Featured image ID. When importing an article, its images need rehosting first: see [Rehost source images during a migration](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#rehost-source-images-during-a-migration) and the [image caveat](https://accounts.myclickfunnels.com/.well-known/blogs/import-external-post/skill.md#image-caveat). |
| `seo_title` | string | No | SEO page title |
| `author_ids` | array | No | IDs of authors to associate with the post |
| `visibility` | string ("draft" | "public" | "members_only" | "scheduled") | No | Visibility status. One of `draft`, `public`, `members_only`, or `scheduled`. See [Two gotchas worth knowing](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#two-gotchas-worth-knowing) in the [Blogs Skill](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md). |
| `category_ids` | array | No | IDs of categories to associate with the post |
| `published_at` | string | No | Date and time to publish the post. Required when visibility is `scheduled`. See [Publish separately](https://accounts.myclickfunnels.com/.well-known/blogs/import-external-post/skill.md#7-publish-separately) in the [Import External Blog Post Skill](https://accounts.myclickfunnels.com/.well-known/blogs/import-external-post/skill.md). |
| `excerpt_content` | string | No | Short summary of the blog post |
| `seo_description` | string | No | SEO page description |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Blog Tag

**Slug:** `CLICKFUNNELS_CREATE_BLOG_TAG`

Create Blog Tag. API access tokens need blog:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Tag name |
| `blog_id` | string | Yes | Identifier used for the blog id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Community

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES`

Create Community. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Community Name |
| `status` | string | No | Status of the community (e.g. live, draft) |
| `private` | boolean | No | Make this Community Private? |
| `seo_title` | string | No | Seo Title |
| `invite_only` | boolean | No | Invite Only? |
| `upgrade_url` | string | No | Upgrade URL |
| `white_label` | boolean | No | Enable White Label |
| `current_path` | string | No | Current Path |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `logo_image_id` | integer | No | Logo Image ID |
| `notifications` | string | No | Notification settings (e.g. all, essential, off) |
| `seo_indexable` | boolean | No | Seo Indexable? |
| `seo_description` | string | No | Seo Description |
| `social_image_id` | integer | No | Social Image ID |
| `anyone_can_invite` | boolean | No | Anyone Can Invite? |
| `enable_block_list` | boolean | No | Enable Block List? |
| `send_digest_email` | boolean | No | Send Digest Email? |
| `allow_public_signup` | boolean | No | Allow Public Sign-Up? |
| `send_membership_email` | boolean | No | Send Membership Email? |
| `require_post_approvals` | boolean | No | Require Post Approvals? |
| `require_comment_approvals` | boolean | No | Require Comment Approvals? |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ban

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_BANS`

Create Ban. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | No | Optional reason for the ban (max 1024 characters) |
| `contact_id` | string | Yes | Public ID of the Contact to ban |
| `community_id` | string | Yes | Identifier used for the community id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ban Export Action

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_BANS_EXPORT_ACTIONS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Array of column names to include in the export |
| `target_all` | boolean | No | When true, export all bans in the community (target_ids is ignored) |
| `target_ids` | array | No | Array of ban public IDs to export. Required when target_all is false. |
| `community_id` | string | Yes | Identifier used for the community id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ban Unban Action

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_BANS_UNBAN_ACTIONS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_all` | boolean | No | When true, unban all banned contacts in the community (target_ids is ignored) |
| `target_ids` | array | No | Array of ban public IDs to unban. Required when target_all is false. |
| `community_id` | string | Yes | Identifier used for the community id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Membership

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPS`

Create Membership. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `moderator` | boolean | No | Whether this member should have moderator privileges |
| `space_ids` | array | No | 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. |
| `contact_id` | string | Yes | Public ID of the Contact to add as a member |
| `community_id` | string | Yes | Identifier used for the community id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Membership Add-To-Group Action

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPS_ADD_TO_GROUP_ACTIONS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `space_ids` | array | No | Array of space public IDs to add the members to |
| `target_all` | boolean | No | When true, add all members in the community to the specified spaces (target_ids is ignored) |
| `target_ids` | array | No | Array of membership public IDs to add to the spaces. Required when target_all is false. |
| `community_id` | string | Yes | Identifier used for the community id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Membership Ban Action

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPS_BAN_ACTIONS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | No | Optional reason applied to each ban |
| `target_all` | boolean | No | When true, ban all members in the community (target_ids is ignored) |
| `target_ids` | array | No | Array of membership public IDs to ban. Required when target_all is false. |
| `community_id` | string | Yes | Identifier used for the community id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Membership Export Action

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPS_EXPORT_ACTIONS`

Create Membership Export Action. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Array of column names to include in the export |
| `target_all` | boolean | No | When true, export all members in the community (target_ids is ignored) |
| `target_ids` | array | No | Array of membership public IDs to export. Required when target_all is false. |
| `community_id` | string | Yes | Identifier used for the community id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Membership Remove-From-Group Action

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_MEMBERSHIPS_REMOVE_FROM_GROUP_ACTIONS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `space_ids` | array | No | Array of space public IDs to remove the members from |
| `target_all` | boolean | No | When true, remove all members in the community from the specified spaces (target_ids is ignored) |
| `target_ids` | array | No | Array of membership public IDs to remove from the spaces. Required when target_all is false. |
| `community_id` | string | Yes | Identifier used for the community id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Space Group

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_SPACE_GROUPS`

Create Space Group. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name |
| `emoji` | string | No | Emoji icon for the group |
| `access` | integer | No | Access level (0 = open, 1 = private, 2 = secret) |
| `always_on` | boolean | No | Always On |
| `is_hidden` | boolean | No | Only show joined Topics |
| `group_type` | integer | No | Group type (integer enum) |
| `sort_order` | integer | No | Sort order within the community |
| `description` | string | No | Description |
| `upgrade_url` | string | No | Upgrade URL |
| `community_id` | string | Yes | Identifier used for the community id path segment. |
| `current_path` | string | No | Current Path |
| `card_image_id` | integer | No | Card Image ID |
| `approval_terms` | string | No | Approval Terms |
| `auto_add_to_spaces` | boolean | No | Automatically add members to new Topics within this Group |
| `require_post_approvals` | boolean | No | Require approvals for posts in this Group? |
| `require_comment_approvals` | boolean | No | Require approvals for comments in this Group? |
| `is_hidden_from_non_members` | boolean | No | Hide from non-members |
| `require_post_approvals_override` | boolean | No | Override community-level post approval setting for this group |
| `require_comment_approvals_override` | boolean | No | Override community-level comment approval setting for this group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Space

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_SPACES`

Create Space. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name |
| `emoji` | string | No | Emoji icon for the space |
| `access` | integer | No | Access level (0 = open, 1 = private, 2 = secret) |
| `always_on` | boolean | No | Always On |
| `seo_title` | string | No | Seo Title |
| `sort_order` | integer | No | Sort order within the space group |
| `default_tab` | string | No | Default tab shown when viewing the space |
| `upgrade_url` | string | No | Upgrade URL |
| `current_path` | string | No | Current Path |
| `layout_style` | string | No | Layout style for the space |
| `card_image_id` | integer | No | Card Image ID |
| `space_group_id` | string | Yes | Identifier used for the space group id path segment. |
| `seo_description` | string | No | Seo Description |
| `social_image_id` | integer | No | Social Image ID |
| `members_can_post` | boolean | No | Whether members can post in this space |
| `allow_post_titles` | boolean | No | Whether posts can have titles |
| `default_post_sort` | string | No | Default sort order for posts |
| `allow_cover_images` | boolean | No | Whether posts can have cover images |
| `hide_from_featured` | boolean | No | Whether to hide this space from the featured spaces list |
| `members_can_invite` | boolean | No | Whether members can invite others to this space |
| `pinned_posts_label` | string | No | Label for pinned posts section |
| `default_member_sort` | string | No | Default sort order for members |
| `default_comment_sort` | string | No | Default sort order for comments |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Post

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTS`

Create Post. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | Post body as rich HTML |
| `title` | string | Yes | Post title |
| `image_id` | integer | No | Cover image ID |
| `space_id` | string | Yes | Identifier used for the space id path segment. |
| `is_pinned` | boolean | No | Whether to pin the post at the top of the space |
| `contact_id` | integer | No | ID of the Contact to author the post. Optional — defaults to the connected user's own contact. |
| `current_path` | string | No | Current path (used for tracking purposes) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Comment

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTS_COMMENTS`

Create Comment. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Comment body as rich HTML |
| `post_id` | string | Yes | Identifier used for the post id path segment. |
| `contact_id` | integer | No | ID of the Contact to author the comment. Optional — defaults to the connected user's own contact. |
| `parent_comment_id` | integer | No | ID of the parent comment for threaded replies. Must be a comment on the same post. |
| `skip_notifications` | boolean | No | When true, suppresses email/push notifications for this comment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Comment Like

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTS_COMMENTS_LIKES`

Create Comment Like. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment_id` | string | Yes | Identifier used for the comment id path segment. |
| `contact_id` | integer | No | ID of the Contact to record the like for. Optional — defaults to the connected user's own contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Post Like

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTS_LIKES`

Create Post Like. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | Yes | Identifier used for the post id path segment. |
| `contact_id` | integer | No | ID of the Contact to record the like for. Optional — defaults to the connected user's own contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Video Embed

**Slug:** `CLICKFUNNELS_CREATE_COMMUNITIES_SPACES_POSTS_VIDEO_EMBEDS`

Create Video Embed. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Source URL of the video |
| `data` | object | No | Provider-specific metadata (arbitrary key/value pairs) |
| `post_id` | string | Yes | Identifier used for the post id path segment. |
| `provider` | string ("youtube" | "vimeo" | "loom" | "voomly") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS`

Create Contact. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fb_url` | string | No | Facebook URL |
| `tag_ids` | array | No | 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). |
| `expand__` | array | No | Expand additional data in the response. Use `expand[]=field_name` to include optional fields (e.g., `expand[]=email_engagement`). See the [Expanding guide](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |
| `last_name` | string | No | Last name |
| `time_zone` | string | No | 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.](https://dash.readme.com/project/cf2/v2/docs/timezones). |
| `first_name` | string | No | First name |
| `twitter_url` | string | No | Twitter URL |
| `website_url` | string | No | Website URL |
| `linkedin_url` | string | No | LinkedIn URL |
| `phone_number` | string | No | Phone number |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `email_address` | string | No | Email address |
| `instagram_url` | string | No | Instagram URL |
| `custom_attributes` | object | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Applied Tag

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS_APPLIED_TAGS`

Create Applied Tag. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | integer | Yes | Tag ID |
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create contact billing address

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS_BILLING_ADDRESS`

Create contact billing address. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | Yes | City |
| `region` | string | No | State code or full region name for the country; unknown values return 422 |
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |
| `address_one` | string | Yes | Street line 1 |
| `address_two` | string | No | Street line 2 |
| `postal_code` | string | Yes | Postal code, at most 10 characters |
| `country_code` | string | Yes | ISO2 country code; unknown values return 422 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Enroll Action

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS_ENROLL_ACTIONS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stable_id` | string | No | 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`. |
| `course_ids` | array | No | 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. |
| `target_all` | boolean | No | Set to `true` to target every contact in the workspace. Use deliberately. Mutually exclusive with `stable_id`, `stored_filter_id`, and `target_ids`. |
| `target_ids` | array | No | 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`. |
| `section_ids` | array | No | Public IDs of specific course sections to enroll contacts into. Use when you want finer-grained control than `course_ids`. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `scheduled_for` | string | No | Optional ISO 8601 datetime. When supplied the action is deferred until this time. Omit (or pass `null`) to execute immediately. |
| `stored_filter_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact Activity Note

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS_EVENTS_NOTES`

Create Contact Activity Note. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | string | Yes | Required nonblank text on creation; no length cap. |
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |
| `occurred_at` | string | No | Optional ISO 8601 timestamp. Defaults to server time on creation; omission on update preserves its occurrence time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Export Action

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS_EXPORT_ACTIONS`

Create Export Action. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | Yes | 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. |
| `stable_id` | string | No | 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`. |
| `target_all` | boolean | No | Set to `true` to target every contact in the workspace. Use deliberately. Mutually exclusive with `stable_id`, `stored_filter_id`, and `target_ids`. |
| `target_ids` | array | No | 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`. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `scheduled_for` | string | No | Optional ISO 8601 datetime. When supplied the action is deferred until this time. Omit (or pass `null`) to execute immediately. |
| `stored_filter_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Run Workflow Action

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS_RUN_WORKFLOW_ACTIONS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `force_run` | boolean | No | When `true`, contacts already enrolled in the workflow are re-enqueued. Defaults to `false`. |
| `stable_id` | string | No | 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`. |
| `target_all` | boolean | No | Set to `true` to target every contact in the workspace. Use deliberately. Mutually exclusive with `stable_id`, `stored_filter_id`, and `target_ids`. |
| `target_ids` | array | No | 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`. |
| `workflow_id` | string | Yes | The `public_id` of the workflow to run against the targeted contacts. Required. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `scheduled_for` | string | No | Optional ISO 8601 datetime. When supplied the action is deferred until this time. Omit (or pass `null`) to execute immediately. |
| `stored_filter_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag Action

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS_TAG_ACTIONS`

Create Tag Action. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_ids` | array | Yes | 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). |
| `stable_id` | string | No | 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`. |
| `target_all` | boolean | No | Set to `true` to target every contact in the workspace. Use deliberately. Mutually exclusive with `stable_id`, `stored_filter_id`, and `target_ids`. |
| `target_ids` | array | No | 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`. |
| `action_type` | string ("add" | "remove") | No | `"add"` (default) applies the tags; `"remove"` removes them. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `scheduled_for` | string | No | Optional ISO 8601 datetime. When supplied the action is deferred until this time. Omit (or pass `null`) to execute immediately. |
| `stored_filter_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS_TAGS`

Create Tag. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name |
| `color` | string | No | Tag Color |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Unsubscribe Action

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS_UNSUBSCRIBE_ACTIONS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stable_id` | string | No | 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`. |
| `target_all` | boolean | No | Set to `true` to target every contact in the workspace. Use deliberately. Mutually exclusive with `stable_id`, `stored_filter_id`, and `target_ids`. |
| `target_ids` | array | No | 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`. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `scheduled_for` | string | No | Optional ISO 8601 datetime. When supplied the action is deferred until this time. Omit (or pass `null`) to execute immediately. |
| `stored_filter_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Opt a Contact out of a Topic

**Slug:** `CLICKFUNNELS_CREATE_CONTACTS_UNSUBSCRIBED_TOPICS`

Opt a Contact out of a Topic. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `topic_id` | integer | Yes | An active topic ID in the contact's workspace. |
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Course

**Slug:** `CLICKFUNNELS_CREATE_COURSES`

Create Course. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Title |
| `image_id` | integer | No | The ID of an Image to show on the storefront of the main course page |
| `description` | string | No | Description |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `show_in_community` | boolean | No | Show In Customer Center? |
| `redirect_to_full_course` | boolean | No | Redirect To Full Course |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Enrollment

**Slug:** `CLICKFUNNELS_CREATE_COURSES_ENROLLMENTS`

Create Enrollment. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `course_id` | string | Yes | Identifier used for the course id path segment. |
| `suspended` | boolean | No | Suspended |
| `contact_id` | integer | Yes | Contact ID |
| `suspension_reason` | string | No | Suspension Reason |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Lesson Completion

**Slug:** `CLICKFUNNELS_CREATE_COURSES_LESSON_COMPLETIONS`

Create Lesson Completion. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `course_id` | string | Yes | Identifier used for the course id path segment. |
| `lesson_id` | integer | Yes | The ID of the `Courses::Lesson` record that was completed |
| `enrollment_id` | integer | Yes | The ID of the `Courses::Enrollment` record that completed the lesson |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Lesson

**Slug:** `CLICKFUNNELS_CREATE_COURSES_LESSONS`

Create Lesson. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | Description |
| `title` | string | No | Title |
| `image_id` | string | No | Public ID of an image in the workspace to use as the lesson image. |
| `section_id` | string | Yes | Identifier used for the section id path segment. |
| `lesson_content` | string | No | Markdown lesson content. This is the primary content field for the lesson body. It is Markdown, not PML. See [Lessons](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#lessons) in the [Courses Skill](https://accounts.myclickfunnels.com/.well-known/courses/skill.md). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Section

**Slug:** `CLICKFUNNELS_CREATE_COURSES_SECTIONS`

Create Section. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Title |
| `course_id` | string | Yes | Identifier used for the course id path segment. |
| `description` | string | No | Description |
| `blocker_lesson_id` | integer | No | Blocker lesson |
| `blocker_section_id` | integer | No | Blocker section |
| `days_till_drip_access` | integer | No | Days until drip access |
| `is_hidden_from_non_members` | boolean | No | Current Path |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Publish Action

**Slug:** `CLICKFUNNELS_CREATE_COURSES_SECTIONS_PUBLISH_ACTIONS`

Create Publish Action. This can trigger an irreversible external effect. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom HTML Page

**Slug:** `CLICKFUNNELS_CREATE_CUSTOM_HTML_PAGE`

Create Custom HTML Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Page name. |
| `funnel` | object | No | Optional funnel association — provide either `funnel_id` or `show_page_step_id`. Omit the whole block to create a standalone page. |
| `sort_order` | integer | No | 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. |
| `custom_html` | string | Yes | The complete HTML document to serve (max 2MB). |
| `description` | string | No | A short description of the page (max 1000 characters). |
| `current_path` | string | No | Optional URL path on the funnel's domain (e.g. `/my-landing`). Derived from the name when omitted. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discount

**Slug:** `CLICKFUNNELS_CREATE_DISCOUNTS`

Create Discount. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | 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). |
| `name` | string | Yes | Internal name for the discount. |
| `amount` | string | No | Fixed amount off as a decimal string. Required when `discount_method` is `fixed`. |
| `percent` | string | No | Percentage off (0.01-100). Required when `discount_method` is `percentage`. |
| `currency` | string | No | ISO currency code. Defaults to the workspace currency. |
| `applies_to` | string ("all_products" | "specific_products" | "specific_variants" | "specific_collections") | No | Defaults to `all_products`. |
| `apply_from` | string | No | When the discount becomes active. Defaults to now. Set in the future to schedule it. |
| `apply_until` | string | No | 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 } }`. |
| `product_ids` | array | No | Product ids to scope to, when `applies_to` is `specific_products`. |
| `variant_ids` | array | No | Variant ids to scope to, when `applies_to` is `specific_variants`. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `discount_type` | string ("code" | "automatic" | "sale") | No | Defaults to `code`. |
| `discount_method` | string ("percentage" | "fixed" | "shipping" | "bogo") | No | Defaults to `percentage`. `percentage` requires `percent`; `fixed` requires a positive `amount`. |
| `limit_1_per_customer` | boolean | No | Value for the limit 1 per customer request field. |
| `require_minimum_spend` | boolean | No | Value for the require minimum spend request field. |
| `products_collection_ids` | array | No | Collection ids to scope to, when `applies_to` is `specific_collections`. |
| `discounts_per_redemption` | integer | No | Value for the discounts per redemption request field. |
| `require_minimum_spend_amount` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Address

**Slug:** `CLICKFUNNELS_CREATE_EMAILS_ADDRESSES`

Create Email Address. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The from-name shown to recipients (e.g. "Acme Support"). Required when creating. |
| `label` | string | No | Optional internal label. |
| `domain` | string | No | 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. |
| `username` | string | Yes | The local part before the @ (e.g. "hello" for hello@yourdomain.com). Required when creating. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `emails_domain_id` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Broadcast

**Slug:** `CLICKFUNNELS_CREATE_EMAILS_BROADCAST`

Create Email Broadcast. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Internal name for the broadcast (required) |
| `send_at` | string | No | Scheduled send date. Required when send_immediately is false. |
| `subject` | string | No | Email subject line seen by recipients |
| `variants` | array | No | 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. |
| `filter_id` | string | No | 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](https://accounts.myclickfunnels.com/.well-known/refine-filters/skill.md). If `recipients` are provided instead, a filter is created automatically from them and takes precedence over `filter_id`. See [Applying filters to email broadcasts](https://accounts.myclickfunnels.com/.well-known/refine-filters/skill.md#applying-filters-to-email-broadcasts). |
| `html_body` | string | No | HTML email body. If provided without a template_id, a template is automatically created from this content. |
| `text_body` | string | No | Plain text email body |
| `time_zone` | string | No | Time zone for scheduling (defaults to workspace time zone) |
| `topic_ids` | array | No | Topic IDs to associate. Only topics belonging to the workspace are accepted. |
| `from_email` | string | Yes | 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. |
| `recipients` | array | No | List of recipients (maximum 1,000). Contacts are created or matched by email address. |
| `split_test` | boolean | No | 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. |
| `external_id` | string | No | An optional external identifier for your own tracking |
| `preheadline` | string | No | Preview text shown in email clients before opening. Maximum 150 characters. |
| `template_id` | integer | No | 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). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `smart_sending` | boolean | No | 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. |
| `reply_to_email` | string | No | Reply-to email address. Must be an address in the workspace if provided. Pick one whose `usable_as_sender` is `true`. |
| `send_immediately` | boolean | No | Set to true to send the broadcast immediately upon creation. If false, use send_at, send_at_local_time, and time_zone to schedule. |
| `send_at_local_time` | string | No | Scheduled send time in HH:MM:SS format. Defaults to 18:00:00. |
| `smart_sending_time` | number | No | How many `smart_sending_unit`s the delivery window spans, for example `2` with `hour`. Must be between 0.5 and 100, and must be sent together with `smart_sending_unit`. Omit both to size the window from the audience, which is the recommended default. |
| `smart_sending_unit` | string ("hour" | "day") | No | 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. |
| `split_test_wait_time` | integer | No | Whole hours to wait before choosing the subject-line winner. |
| `split_test_percentage` | integer | No | Whole-number share of the audience used for the test sends. The share is divided evenly between variant A and variant B. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Send Action

**Slug:** `CLICKFUNNELS_CREATE_EMAILS_BROADCASTS_SEND_ACTIONS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `send_at` | string | No | 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. |
| `broadcast_id` | string | Yes | Identifier used for the broadcast id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Domain

**Slug:** `CLICKFUNNELS_CREATE_EMAILS_DOMAINS`

Create Email Domain. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | 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. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Template

**Slug:** `CLICKFUNNELS_CREATE_EMAILS_TEMPLATE`

Create Email Template. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Internal name for the template (required) |
| `subject` | string | No | Default email subject line. May be blank. |
| `html_body` | string | No | HTML email body |
| `text_body` | string | No | Plain text email body |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `from_address_id` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Topic

**Slug:** `CLICKFUNNELS_CREATE_EMAILS_TOPIC`

Create Email Topic. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Topic name |
| `description` | string | No | Topic description |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create External Page

**Slug:** `CLICKFUNNELS_CREATE_EXTERNAL_PAGE`

Create External Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Page name. Defaults to the URL host if omitted. |
| `funnel` | object | No | 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). |
| `sort_order` | integer | No | 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. |
| `description` | string | No | A short description of the page (max 1000 characters). |
| `external_url` | string | Yes | The fully-qualified URL of the externally-hosted page (e.g. `https://acme.example.com/my-page`). Must be unique within the workspace. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Form

**Slug:** `CLICKFUNNELS_CREATE_FORMS`

Create Form. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Field

**Slug:** `CLICKFUNNELS_CREATE_FORMS_FIELDS`

Create Field. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Key |
| `label` | string | Yes | Label |
| `hidden` | boolean | No | Hidden |
| `field_type` | string | No | Field Type |
| `field_set_id` | string | Yes | Identifier used for the field set id path segment. |
| `allow_multiple` | boolean | No | Allow Multiple |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Field Set

**Slug:** `CLICKFUNNELS_CREATE_FORMS_FIELD_SETS`

Create Field Set. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Title |
| `form_id` | string | Yes | Identifier used for the form id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Option

**Slug:** `CLICKFUNNELS_CREATE_FORMS_FIELDS_OPTIONS`

Create Option. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | Yes | Label |
| `field_id` | string | Yes | Identifier used for the field id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Submission

**Slug:** `CLICKFUNNELS_CREATE_FORMS_SUBMISSIONS`

Create Submission. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form_id` | string | Yes | Identifier used for the form id path segment. |
| `contact_id` | integer | No | Contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Answer

**Slug:** `CLICKFUNNELS_CREATE_FORMS_SUBMISSIONS_ANSWERS`

Create Answer. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entry` | string | No | Entry |
| `field_id` | integer | Yes | Field |
| `submission_id` | string | Yes | Identifier used for the submission id path segment. |
| `fields_option_id` | integer | No | ID of a record from the Forms::Fields::Option API. |
| `fields_option_ids` | array | No | Fields Options |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Fulfillment

**Slug:** `CLICKFUNNELS_CREATE_FULFILLMENTS`

Create Fulfillment. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | The contact that made the order that is being fulfilled. |
| `location_id` | integer | Yes | The location that the fulfillment is being fulfilled from |
| `tracking_url` | string | No | Tracking URL |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `tracking_code` | string | No | Tracking Code |
| `notify_customer` | boolean | No | Send an email to the customer when the fulfillment is created. Will use workspace default behavior if left unset. |
| `shipping_provider` | string | No | Shipping Provider |
| `ignore_out_of_stock` | boolean | No | Create a fulfillment despite the item being out of stock. |
| `included_orders_invoices_line_items_attributes` | array | Yes | The orders invoices line items to fulfill as part of this fulfillment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Location

**Slug:** `CLICKFUNNELS_CREATE_FULFILLMENTS_LOCATIONS`

Create Location. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Location name |
| `address` | object | No | Value for the address request field. |
| `archived` | boolean | No | Indicates if the location is archived |
| `address_name` | string | Yes | Address name |
| `external_app` | boolean | No | 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. |
| `phone_number` | string | No | Phone number |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `email_address` | string | Yes | Email address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Funnel

**Slug:** `CLICKFUNNELS_CREATE_FUNNEL`

Create Funnel. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the Funnel |
| `tag_ids` | array | No | An array of tag IDs to associate with this funnel |
| `domain_id` | integer | No | The ID of the domain to associate with this funnel. Use the Domains API to look up available domain IDs. |
| `head_code` | string | No | 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>. |
| `live_mode` | boolean | No | 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. |
| `footer_code` | string | No | Custom code to inject before the closing </body> tag. JavaScript should be wrapped in <script> tags. |
| `current_path` | string | No | The URL path for the funnel. If not provided, a path will be auto-generated from the name. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `head_code_mode` | string ("append" | "replace") | No | How to handle head_code. 'append' adds to existing code (default), 'replace' overwrites. |
| `footer_code_mode` | string ("append" | "replace") | No | How to handle footer_code. 'append' adds to existing code (default), 'replace' overwrites. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Conditional Split Step

**Slug:** `CLICKFUNNELS_CREATE_FUNNEL_CONDITIONAL_SPLIT_STEP`

Create Conditional Split Step. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branches` | array | No | Optional 0..2 branch entries; `branches[0]` is the matched branch, `branches[1]` is the unmatched branch. |
| `condition` | object | No | Value for the condition request field. |
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |
| `show_page_step_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate Funnel Asynchronously

**Slug:** `CLICKFUNNELS_CREATE_FUNNELS_CLONE_ACTIONS`

Duplicate Funnel Asynchronously. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `funnel_id` | string | Yes | Source funnel integer ID or public ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Split Test Step

**Slug:** `CLICKFUNNELS_CREATE_FUNNEL_SPLIT_TEST_STEP`

Create Split Test Step. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variants` | array | Yes | 1 or 2 variant entries. |
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |
| `show_page_step_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `CLICKFUNNELS_CREATE_FUNNELS_TAGS`

Create Tag. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the funnel tag |
| `color` | string | No | The color of the funnel tag |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Image

**Slug:** `CLICKFUNNELS_CREATE_IMAGES`

Create Image. API access tokens need media:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Image name |
| `alt_text` | string | No | Image alt attribute |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `upload_source_url` | string | Yes | The source URL of the image that you want to upload. Not required on Update when not needed to re-upload the image. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create External Order

**Slug:** `CLICKFUNNELS_CREATE_ORDERS`

Create External Order. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | string | No | Your internal note about the order. This will be visible in ClickFunnels admin orders-related sections. |
| `live_mode` | boolean | Yes | 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. |
| `churned_at` | string | No | Churned At |
| `contact_id` | integer | No | 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. |
| `order_type` | string ("one-time-order" | "subscription-order") | Yes | 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. |
| `canceled_at` | string | No | Order Canceled At |
| `canceled_by` | string | No | Order Canceled By |
| `external_id` | string | No | An external ID, e.g., a payment provider's ID or an ID managed by the client internally |
| `activated_at` | string | No | Date Activated |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `cancel_reason` | string | No | 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. |
| `billing_status` | string | No | 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`. |
| `next_charge_at` | string | No | The date and time of the next scheduled charge for subscription orders. (External subscription orders only) |
| `service_status` | string | No | 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](https://developers.myclickfunnels.com/docs/orders).  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`. |
| `cancel_description` | string | No | A free-text description of the cancellation reason. |
| `contact_attributes` | object | No | 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. |
| `billing_address_city` | string | No | The city of the billing address. |
| `line_items_attributes` | array | Yes | 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`. |
| `shipping_address_city` | string | No | The city of the shipping address. |
| `billing_address_region` | string | No | The region of the shipping address, like state or province. |
| `billing_address_country` | string | No | The billing address country. |
| `shipping_address_region` | string | No | The region of the shipping address, like state or province. |
| `shipping_address_country` | string | No | The country of the shipping address. |
| `billing_address_street_one` | string | No | The main street information of the billing address, including the street name and number. |
| `billing_address_street_two` | string | No | Additional street information of the billing address, like entrance information and apartment numbers. |
| `shipping_address_last_name` | string | No | The last name of the recipient's shipping address. |
| `billing_address_postal_code` | string | No | Billing address postal (ZIP) code. |
| `shipping_address_first_name` | string | No | The first name of the recipient's shipping address. |
| `shipping_address_street_one` | string | No | The main street information of the shipping address, including the street name and number. |
| `shipping_address_street_two` | string | No | Additional street information for the shipping address, like entrance information and apartment numbers. |
| `shipping_address_postal_code` | string | No | Postal Code |
| `shipping_address_phone_number` | string | No | The phone number of the recipient's shipping address. |
| `shipping_address_organization_name` | string | No | The organization name of the recipient's shipping address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Applied Tag

**Slug:** `CLICKFUNNELS_CREATE_ORDERS_APPLIED_TAGS`

Create Applied Tag. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | integer | Yes | Tag ID |
| `order_id` | string | Yes | Identifier used for the order id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create External Invoice

**Slug:** `CLICKFUNNELS_CREATE_ORDERS_INVOICES`

Create External Invoice. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `due_at` | string | No | The date the invoice is due. |
| `status` | string ("unpaid" | "paid" | "voided" | "refunded" | "disputed" | "past-due") | Yes | 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`. |
| `paid_at` | string | No | The date the invoice was paid. Required when `status` is `paid`. |
| `order_id` | string | Yes | Identifier used for the order id path segment. |
| `issued_at` | string | No | The date the invoice was issued. |
| `external_id` | string | Yes | 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. |
| `invoice_type` | string ("initial" | "renewal" | "interim" | "cancellation" | "one_time" | "refund" | "charge" | "one_time_sale") | No | 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. |
| `invoice_number` | string | No | Optional. A sequential number for bookkeeping purposes. If not provided, one will be auto-generated. |
| `shipping_amount` | string | No | Invoiced shipping amount. Cannot be negative. Defaults to "0.00". |
| `line_items_attributes` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `CLICKFUNNELS_CREATE_ORDERS_TAGS`

Create Tag. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name (maximum 40 characters) |
| `color` | string | No | Tag Color |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Page

**Slug:** `CLICKFUNNELS_CREATE_PAGE`

Create Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Page name of the editable page element. |
| `expand` | array | No | 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](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. Read a page's existing markup with `expand[]=markup` before editing it: see [Reading Current Markup](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#reading-current-markup) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md). |
| `funnel` | object | No | 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. |
| `markup` | string | No | 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](https://accounts.myclickfunnels.com/.well-known/page-markup/skill.md) for the full DSL reference. The parser errors are listed under [Common Validation Errors](https://accounts.myclickfunnels.com/.well-known/page-markup/skill.md#common-validation-errors). |
| `theme_id` | integer | No | The ID of the theme to use for this page. |
| `head_code` | string | No | 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. |
| `seo_index` | boolean | No | Whether search engines should index this page. Defaults to false. |
| `seo_title` | string | No | Custom title for search engine results. |
| `custom_css` | string | No | 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. |
| `sort_order` | integer | No | 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. |
| `description` | string | No | A short description of the page (max 1000 characters). |
| `footer_code` | string | No | Custom code to inject before the closing </body> tag. JavaScript should be wrapped in <script> tags. Set to null to clear existing code. |
| `current_path` | string | No | 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`)](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#setting-a-pages-path-current_path) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md) for the path rules. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `head_code_mode` | string ("append" | "replace") | No | How to handle head_code. 'append' adds to existing code (default), 'replace' overwrites. |
| `show_page_step` | object | No | 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_search` | boolean | No | 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)](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#crawler-access-ai-opt-out) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md) for coverage limits. |
| `custom_css_mode` | string ("append" | "replace") | No | How to handle custom_css. 'append' adds to existing CSS (default), 'replace' overwrites. |
| `seo_description` | string | No | Custom meta description for search engine results. |
| `block_ai_crawler` | boolean | No | 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)](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#crawler-access-ai-opt-out) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md) for coverage limits. |
| `footer_code_mode` | string ("append" | "replace") | No | How to handle footer_code. 'append' adds to existing code (default), 'replace' overwrites. |
| `block_ai_assistant` | boolean | No | 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)](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#crawler-access-ai-opt-out) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md) for coverage limits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product

**Slug:** `CLICKFUNNELS_CREATE_PRODUCTS`

Create Product. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Product name |
| `tag_ids` | array | No | 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) |
| `image_ids` | array | No | Images |
| `seo_title` | string | No | A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters. |
| `current_path` | string | No | Current Path |
| `seo_image_id` | string | No | SEO image |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `commissionable` | boolean | No | Commissionable |
| `seo_description` | string | No | 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). |
| `visible_in_store` | boolean | No | Visible in Store |
| `redirect_funnel_id` | string | No | Redirect funnel |
| `variant_properties` | array | No | The properties of the product's variants. e.g. 'Size', 'Color' etc. |
| `cancellation_funnel_url` | string | No | Cancellation Funnel Url |
| `visible_in_customer_center` | boolean | No | Visible in Customer Center |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Collection

**Slug:** `CLICKFUNNELS_CREATE_PRODUCTS_COLLECTIONS`

Create Collection. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the products collection |
| `image_id` | string | No | Collection image |
| `seo_title` | string | No | Title of the collection for SEO purposes |
| `description` | string | No | Description of the collection |
| `product_ids` | array | No | 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. |
| `sort_method` | string ("manually" | "name_asc" | "name_desc" | "price_desc" | "price_asc" | "added_at_desc" | "added_at_asc" | "created_at_desc" | "created_at_asc") | No | Method used to sort the products in the collection |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `collection_type` | string | No | Type of the collection (manual or automatic) |
| `seo_description` | string | No | Description of the collection for SEO purposes |
| `social_image_id` | string | No | Image for social sharing |
| `visible_in_store` | boolean | No | Whether the collection is visible in the online store |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Price

**Slug:** `CLICKFUNNELS_CREATE_PRODUCTS_PRICES`

Create Price. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | No | Key |
| `cost` | string | No | Cost |
| `name` | string | No | Name |
| `amount` | string | Yes | Amount, as a decimal string. Omitting it does not fail — it silently creates a free price ('0.00') — so always send it. |
| `visible` | boolean | No | Visible |
| `archived` | boolean | No | Archived |
| `currency` | string | No | Currency. Ignored on write — a price always takes its workspace's currency, so sending a different one has no effect. |
| `duration` | integer | No | Amount of payments. Required when payment_type is payment_plan; ignored for one_time and subscription. |
| `interval` | string ("days" | "weeks" | "months" | "quarters" | "years") | No | Billing period unit — note the values are plural ('months', not 'month'). Required when payment_type is subscription or payment_plan; ignored for one_time. |
| `variant_id` | string | Yes | Identifier used for the variant id path segment. |
| `self_cancel` | boolean | No | Customer can cancel |
| `payment_type` | string ("one_time" | "subscription" | "payment_plan") | No | Defaults to 'one_time' if left blank |
| `self_upgrade` | boolean | No | 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. |
| `setup_amount` | string | No | Setup amount |
| `trial_amount` | string | No | 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. |
| `interval_count` | integer | No | How many intervals between charges — interval 'months' with interval_count 3 bills every 3 months. Required when payment_type is subscription or payment_plan. |
| `self_downgrade` | boolean | No | 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. |
| `trial_duration` | integer | No | 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. |
| `trial_interval` | string ("days" | "weeks" | "months" | "quarters" | "years") | No | 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. |
| `self_reactivate` | boolean | No | Customer can reactivate |
| `compare_at_amount` | string | No | Compare at amount |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `CLICKFUNNELS_CREATE_PRODUCTS_TAGS`

Create Tag. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name (maximum 40 characters) |
| `color` | string | No | The color of the product tag |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Variant

**Slug:** `CLICKFUNNELS_CREATE_PRODUCTS_VARIANTS`

Create Variant. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | No | SKU |
| `name` | string | Yes | Name |
| `width` | number | No | Width |
| `height` | number | No | Height |
| `length` | number | No | Length |
| `weight` | number | No | Weight |
| `taxable` | string | No | Taxable |
| `visible` | boolean | No | Is visible |
| `archived` | boolean | No | Archived |
| `asset_ids` | array | No | 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. |
| `image_ids` | array | No | The images for the variant. |
| `product_id` | string | Yes | Identifier used for the product id path segment. |
| `description` | string | No | The description of the variant. The description of the **default variant** is the user-facing description of the `Product`. |
| `weight_unit` | string | Yes | Weight unit |
| `product_type` | string ("physical" | "digital") | Yes | `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. |
| `track_quantity` | boolean | No | Track Quantity |
| `dimensions_unit` | string | No | Dimensions unit |
| `tax_category_id` | string | No | Tax category ID |
| `properties_values` | array | Yes | The property values of the Variant. e.g. 'Large', 'Red' etc. |
| `out_of_stock_sales` | boolean | No | Out of stock sales |
| `fulfillment_required` | boolean | No | Fulfillment required |
| `country_of_manufacture_id` | string | No | Country of manufacture |
| `fulfillments_location_ids` | array | No | The fulfillment locations for the variant. |
| `included_courses_attributes` | array | No | 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. |
| `has_access_to_all_valid_assets` | boolean | No | 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. |
| `included_space_groups_attributes` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Opportunity

**Slug:** `CLICKFUNNELS_CREATE_SALES_OPPORTUNITIES`

Create Opportunity. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name |
| `value` | number | No | The potential value of this opportunity in the default currency of the workspace |
| `closed_at` | string | No | Close date |
| `assignee_id` | integer | No | 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`. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `pipelines_stage_id` | integer | Yes | Pipeline Stage |
| `primary_contact_id` | integer | Yes | Primary Contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Note

**Slug:** `CLICKFUNNELS_CREATE_SALES_OPPORTUNITIES_NOTES`

Create Note. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | string | Yes | Content |
| `created_by_id` | integer | No | 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. |
| `opportunity_id` | string | Yes | Identifier used for the opportunity id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Pipeline

**Slug:** `CLICKFUNNELS_CREATE_SALES_PIPELINES`

Create Pipeline. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Pipeline name |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `stages_attributes` | array | Yes | The stages of the pipeline. The stages are ordered by the position attribute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Stage

**Slug:** `CLICKFUNNELS_CREATE_SALES_PIPELINES_STAGES`

Create Stage. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Stage name |
| `sort_order` | integer | No | 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. |
| `pipeline_id` | string | Yes | Identifier used for the pipeline id path segment. |
| `close_probability` | number | Yes | Close probability of the opportunities in this stage |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Segment

**Slug:** `CLICKFUNNELS_CREATE_SEGMENTS`

Create Segment. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `results` | string | No | Return matching contacts inline; omit for the audience definition alone. Requires contacts:read. Count is opt-in. |
| `segment` | object | Yes | Value for the segment request field. |
| `body_results` | string | No | Return projected matches inline. Pass `true` for ids only; omit for the filter definition alone. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create shipping addresses

**Slug:** `CLICKFUNNELS_CREATE_SHIPPING_ADDRESSES`

Create shipping addresses. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address` | object | Yes | Complete postal street. Row IDs, owner fields, internal geography IDs and checkout verification are read-only and ignored if supplied. |
| `default` | boolean | No | Set true to select this entry. False on the current default returns 422; select another entry instead. |
| `last_name` | string | No | Last name |
| `contact_id` | string | Yes | Contact ID |
| `first_name` | string | No | First name |
| `phone_number` | string | No | Phone number |
| `organization_name` | string | No | Organization name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Package

**Slug:** `CLICKFUNNELS_CREATE_SHIPPING_PACKAGES`

Create Package. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name |
| `width` | number | Yes | Width |
| `height` | number | Yes | Height |
| `length` | number | Yes | Length |
| `weight` | number | No | Weight |
| `carrier` | string ("fedex" | "ups" | "usps") | No | Carrier |
| `weight_unit` | string ("lb" | "kg" | "g" | "oz") | No | Weight Unit |
| `empty_weight` | string | No | Empty Weight |
| `package_type` | string ("box" | "envelope" | "soft_package") | Yes | Package Type |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `distance_unit` | string ("in" | "cm" | "ft" | "m" | "mm") | Yes | Distance Unit |
| `default_package` | boolean | No | Default Package |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Profile

**Slug:** `CLICKFUNNELS_CREATE_SHIPPING_PROFILES`

Create Profile. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name |
| `variant_ids` | array | No | Variant IDs |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Rate

**Slug:** `CLICKFUNNELS_CREATE_SHIPPING_RATES`

Create Rate. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `price` | string | Yes | Price |
| `zone_id` | string | Yes | Identifier used for the zone id path segment. |
| `provider_name` | string | No | Provider Name |
| `rates_name_id` | integer | Yes | Rate name ID |
| `price_currency` | string | No | Price Currency |
| `live_rates_provider` | string | No | Live Rates Provider |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Name

**Slug:** `CLICKFUNNELS_CREATE_SHIPPING_RATES_NAMES`

Create Name. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Rate Name |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Zone

**Slug:** `CLICKFUNNELS_CREATE_SHIPPING_ZONES`

Create Zone. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name |
| `region_ids` | array | No | Region IDs |
| `country_ids` | array | No | Country IDs |
| `address_filter_id` | string | No | Zone |
| `location_group_id` | string | Yes | Identifier used for the location group id path segment. |
| `includes_rest_of_world` | boolean | No | Includes Rest of the World |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Store

**Slug:** `CLICKFUNNELS_CREATE_STORES`

Create Store. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name |
| `status` | string ("draft" | "published") | No | Store Status |
| `seo_title` | string | No | SEO title |
| `current_path` | string | No | Current path |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `seo_indexable` | boolean | No | SEO Indexable |
| `seo_description` | string | No | SEO description |
| `social_image_id` | string | No | Social image |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Short Link

**Slug:** `CLICKFUNNELS_CREATE_URL_REDIRECTS`

Create Short Link. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Short link name. |
| `utm_term` | string | No | UTM term. |
| `domain_id` | string | No | Ready-for-use domain in this workspace (numeric or public ID). Null or 0 selects the default-site domain. |
| `pixel_code` | string | No | Pixel markup; omitted on create or explicit null becomes an empty string. |
| `second_url` | string | No | Optional split destination. |
| `utm_medium` | string | No | UTM medium. |
| `utm_source` | string | No | UTM source. |
| `utm_content` | string | No | UTM content. |
| `current_path` | string | No | Explicit nonblank paths are normalized and require exact ownership: another resource's current URL, historical alias or occupied custom-domain root cannot be taken. Omitted/blank on create and blank on update generate a path; omitted on update preserves it. |
| `original_url` | string | Yes | Required destination on create. |
| `utm_campaign` | string | No | UTM campaign. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `redirect_type` | string ("temporary" | "permanent") | No | Value for the redirect type request field. |
| `split_percentage` | integer | No | Value for the split percentage request field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Incoming External Purchase Endpoint

**Slug:** `CLICKFUNNELS_CREATE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_ENDPOINTS`

Create Incoming External Purchase Endpoint. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Incoming External Purchase Product Mapping

**Slug:** `CLICKFUNNELS_CREATE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_PRODUCT_MAPPINGS`

Create Incoming External Purchase Product Mapping. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `products_price_id` | string | Yes | Integer database id or obfuscated public_id. |
| `products_variant_id` | string | Yes | Integer database id or obfuscated public_id. |
| `external_product_sku` | string | Yes | Provider product, plan, or SKU identifier. For Whop, use the plan ID. |
| `external_purchases_endpoint_id` | string | Yes | Integer ID or obfuscated public ID of the incoming external purchase endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Endpoint

**Slug:** `CLICKFUNNELS_CREATE_WEBHOOKS_OUTGOING_ENDPOINTS`

Create Endpoint. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL that ClickFunnels event webhooks will be sent to. |
| `name` | string | Yes | The custom name for the webhook endpoint. |
| `page_ids` | array | No | 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. |
| `funnel_ids` | array | No | 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. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `event_type_ids` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Workflow

**Slug:** `CLICKFUNNELS_CREATE_WORKFLOW`

Create Workflow. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable name for the workflow. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enroll Contact (Create Run)

**Slug:** `CLICKFUNNELS_CREATE_WORKFLOW_RUN`

Enroll Contact (Create Run). API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Integer database id or obfuscated public_id. |
| `workflow_id` | string | Yes | Integer id or obfuscated public_id of the workflow. |
| `skip_communication` | boolean | No | When true, communication steps (send email, chat message, etc.) are skipped for this run. Defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Step

**Slug:** `CLICKFUNNELS_CREATE_WORKFLOW_STEP`

Create Step. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional human-readable name. Defaults to a titleized version of the step type. |
| `branch` | string | No | Branch selector — `matched`/`unmatched` for conditional splits (legacy `match`/`fallback` still accepted); `"0"`/`"1"` for split tests. |
| `position` | integer | No | 0-based position within the container. Mutually exclusive with `after_step_id`. |
| `workflow_id` | string | Yes | Integer id or obfuscated public_id of the workflow. |
| `after_step_id` | string | No | Integer database id or obfuscated public_id. |
| `parent_step_id` | string | No | Integer database id or obfuscated public_id. |
| `step_type_settings` | object | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Trigger

**Slug:** `CLICKFUNNELS_CREATE_WORKFLOW_TRIGGER`

Create Trigger. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active` | boolean | No | Whether the trigger is active. Defaults to `true` when omitted. |
| `page_id` | string | No | Integer database id or obfuscated public_id. |
| `course_id` | string | No | Integer database id or obfuscated public_id. |
| `funnel_id` | string | No | Integer database id or obfuscated public_id. |
| `product_id` | string | No | Integer database id or obfuscated public_id. |
| `workflow_id` | string | Yes | Integer id or obfuscated public_id of the workflow. |
| `community_id` | string | No | Integer database id or obfuscated public_id. |
| `event_type_key` | 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") | Yes | The event key that fires this trigger (e.g. `$contact.tag_applied`). Must be one of the enumerated keys. |
| `contacts_tag_id` | string | No | Integer database id or obfuscated public_id. |
| `calendar_event_id` | string | No | Integer database id or obfuscated public_id. |
| `courses_lesson_id` | string | No | Integer database id or obfuscated public_id. |
| `workflows_step_id` | string | No | Integer database id or obfuscated public_id. |
| `courses_section_id` | string | No | Integer database id or obfuscated public_id. |
| `product_variant_id` | string | No | Integer database id or obfuscated public_id. |
| `sales_pipelines_id` | string | No | Integer database id or obfuscated public_id. |
| `survey_workflow_id` | string | No | Integer database id or obfuscated public_id. |
| `communities_space_id` | string | No | Integer database id or obfuscated public_id. |
| `emails_broadcasts_id` | string | No | Integer database id or obfuscated public_id. |
| `cancellation_product_id` | string | No | Integer database id or obfuscated public_id. |
| `allow_anonymous_contacts` | boolean | No | Whether to fire for anonymous contacts. |
| `appointments_calendar_id` | string | No | Integer database id or obfuscated public_id. |
| `appointments_event_type_id` | string | No | Integer database id or obfuscated public_id. |
| `communities_space_group_id` | string | No | Integer database id or obfuscated public_id. |
| `subscription_variant_to_id` | string | No | Integer database id or obfuscated public_id. |
| `cancellation_product_variant_id` | string | No | Integer database id or obfuscated public_id. |
| `subscription_cancelation_reason` | string | No | Reason filter for `$order.cancelled` subscription cancellation triggers. |
| `current_sales_pipelines_stage_id` | string | No | Integer database id or obfuscated public_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Refine Filter

**Slug:** `CLICKFUNNELS_CREATE_WORKSPACE_REFINE_FILTER`

Create Refine Filter. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `results` | string | No | Return projected matches inline. Pass `true` for ids only; omit for the filter definition alone. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `refine_filter` | object | Yes | Value for the refine filter request field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Decline Post

**Slug:** `CLICKFUNNELS_DECLINE_COMMUNITIES_SPACES_POST`

Decline 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Decline Comment

**Slug:** `CLICKFUNNELS_DECLINE_COMMUNITIES_SPACES_POSTS_COMMENT`

Decline 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Blog Post

**Slug:** `CLICKFUNNELS_DELETE_BLOG_POST`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Ban

**Slug:** `CLICKFUNNELS_DELETE_COMMUNITIES_BANS`

Remove Ban. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Membership

**Slug:** `CLICKFUNNELS_DELETE_COMMUNITIES_MEMBERSHIPS`

Remove Membership. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Space Group

**Slug:** `CLICKFUNNELS_DELETE_COMMUNITIES_SPACE_GROUPS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Space

**Slug:** `CLICKFUNNELS_DELETE_COMMUNITIES_SPACES`

Remove Space. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Post

**Slug:** `CLICKFUNNELS_DELETE_COMMUNITIES_SPACES_POSTS`

Remove Post. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Comment

**Slug:** `CLICKFUNNELS_DELETE_COMMUNITIES_SPACES_POSTS_COMMENTS`

Remove Comment. This permanently removes the targeted resource. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Comment Like

**Slug:** `CLICKFUNNELS_DELETE_COMMUNITIES_SPACES_POSTS_COMMENTS_LIKES`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Post Like

**Slug:** `CLICKFUNNELS_DELETE_COMMUNITIES_SPACES_POSTS_LIKES`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Video Embed

**Slug:** `CLICKFUNNELS_DELETE_COMMUNITIES_SPACES_POSTS_VIDEO_EMBEDS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Contact

**Slug:** `CLICKFUNNELS_DELETE_CONTACTS`

Remove Contact. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Applied Tag

**Slug:** `CLICKFUNNELS_DELETE_CONTACTS_APPLIED_TAGS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Enroll Action

**Slug:** `CLICKFUNNELS_DELETE_CONTACTS_ENROLL_ACTIONS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact Activity Note

**Slug:** `CLICKFUNNELS_DELETE_CONTACTS_EVENTS_NOTES`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Export Action

**Slug:** `CLICKFUNNELS_DELETE_CONTACTS_EXPORT_ACTIONS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Run Workflow Action

**Slug:** `CLICKFUNNELS_DELETE_CONTACTS_RUN_WORKFLOW_ACTIONS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Tag Action

**Slug:** `CLICKFUNNELS_DELETE_CONTACTS_TAG_ACTIONS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Tag

**Slug:** `CLICKFUNNELS_DELETE_CONTACTS_TAGS`

Remove Tag. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Unsubscribe Action

**Slug:** `CLICKFUNNELS_DELETE_CONTACTS_UNSUBSCRIBE_ACTIONS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resubscribe a Contact to a Topic

**Slug:** `CLICKFUNNELS_DELETE_CONTACTS_UNSUBSCRIBED_TOPICS`

Resubscribe 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Lesson Completion

**Slug:** `CLICKFUNNELS_DELETE_COURSES_LESSON_COMPLETIONS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Publish Action

**Slug:** `CLICKFUNNELS_DELETE_COURSES_SECTIONS_PUBLISH_ACTIONS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Discount

**Slug:** `CLICKFUNNELS_DELETE_DISCOUNTS`

Remove Discount. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Email Address

**Slug:** `CLICKFUNNELS_DELETE_EMAILS_ADDRESSES`

Archive 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Email Broadcast

**Slug:** `CLICKFUNNELS_DELETE_EMAILS_BROADCAST`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Send Action

**Slug:** `CLICKFUNNELS_DELETE_EMAILS_BROADCASTS_SEND_ACTIONS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Email Template

**Slug:** `CLICKFUNNELS_DELETE_EMAILS_TEMPLATE`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Form

**Slug:** `CLICKFUNNELS_DELETE_FORMS`

Remove Form. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Field

**Slug:** `CLICKFUNNELS_DELETE_FORMS_FIELDS`

Remove Field. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Field Set

**Slug:** `CLICKFUNNELS_DELETE_FORMS_FIELD_SETS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Option

**Slug:** `CLICKFUNNELS_DELETE_FORMS_FIELDS_OPTIONS`

Remove Option. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Submission

**Slug:** `CLICKFUNNELS_DELETE_FORMS_SUBMISSIONS`

Remove Submission. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Answer

**Slug:** `CLICKFUNNELS_DELETE_FORMS_SUBMISSIONS_ANSWERS`

Remove Answer. This permanently removes the targeted resource. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Fulfillment

**Slug:** `CLICKFUNNELS_DELETE_FULFILLMENTS`

Remove Fulfillment. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Location

**Slug:** `CLICKFUNNELS_DELETE_FULFILLMENTS_LOCATIONS`

Remove Location. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Tag

**Slug:** `CLICKFUNNELS_DELETE_FUNNELS_TAGS`

Remove Tag. This permanently removes the targeted resource. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Image

**Slug:** `CLICKFUNNELS_DELETE_IMAGES`

Remove Image. This permanently removes the targeted resource. API access tokens need media:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Applied Tag

**Slug:** `CLICKFUNNELS_DELETE_ORDERS_APPLIED_TAGS`

Remove Applied Tag. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Tag

**Slug:** `CLICKFUNNELS_DELETE_ORDERS_TAGS`

Remove Tag. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Page

**Slug:** `CLICKFUNNELS_DELETE_PAGE`

Delete Page. This permanently removes the targeted resource. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Products from Page

**Slug:** `CLICKFUNNELS_DELETE_PRODUCTS_FROM_PAGE`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `product_ids` | array | Yes | One or more product public IDs (or numeric IDs) to detach. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Tag

**Slug:** `CLICKFUNNELS_DELETE_PRODUCTS_TAGS`

Remove Tag. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Opportunity

**Slug:** `CLICKFUNNELS_DELETE_SALES_OPPORTUNITIES`

Remove Opportunity. This permanently removes the targeted resource. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Note

**Slug:** `CLICKFUNNELS_DELETE_SALES_OPPORTUNITIES_NOTES`

Remove Note. This permanently removes the targeted resource. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Pipeline

**Slug:** `CLICKFUNNELS_DELETE_SALES_PIPELINES`

Remove Pipeline. This permanently removes the targeted resource. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Stage

**Slug:** `CLICKFUNNELS_DELETE_SALES_PIPELINES_STAGES`

Remove Stage. This permanently removes the targeted resource. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Segment

**Slug:** `CLICKFUNNELS_DELETE_SEGMENTS`

Delete Segment. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove shipping addresses

**Slug:** `CLICKFUNNELS_DELETE_SHIPPING_ADDRESSES`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Package

**Slug:** `CLICKFUNNELS_DELETE_SHIPPING_PACKAGES`

Remove Package. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Profile

**Slug:** `CLICKFUNNELS_DELETE_SHIPPING_PROFILES`

Remove Profile. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Rate

**Slug:** `CLICKFUNNELS_DELETE_SHIPPING_RATES`

Remove Rate. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Name

**Slug:** `CLICKFUNNELS_DELETE_SHIPPING_RATES_NAMES`

Remove Name. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Zone

**Slug:** `CLICKFUNNELS_DELETE_SHIPPING_ZONES`

Remove Zone. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Store

**Slug:** `CLICKFUNNELS_DELETE_STORES`

Remove Store. This permanently removes the targeted resource. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Short Link

**Slug:** `CLICKFUNNELS_DELETE_URL_REDIRECTS`

Delete Short Link. This permanently removes the targeted resource. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Incoming External Purchase Endpoint

**Slug:** `CLICKFUNNELS_DELETE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_ENDPOINTS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Incoming External Purchase Product Mapping

**Slug:** `CLICKFUNNELS_DELETE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_PRODUCT_MAPPINGS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Endpoint

**Slug:** `CLICKFUNNELS_DELETE_WEBHOOKS_OUTGOING_ENDPOINTS`

Remove Endpoint. This permanently removes the targeted resource. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Workflow

**Slug:** `CLICKFUNNELS_DELETE_WORKFLOW`

Delete Workflow. This permanently removes the targeted resource. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Step

**Slug:** `CLICKFUNNELS_DELETE_WORKFLOW_STEP`

Delete Step. This permanently removes the targeted resource. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Trigger

**Slug:** `CLICKFUNNELS_DELETE_WORKFLOW_TRIGGER`

Delete Trigger. This permanently removes the targeted resource. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Conditional Split Step

**Slug:** `CLICKFUNNELS_DESTROY_FUNNEL_CONDITIONAL_SPLIT_STEP`

Destroy Conditional Split Step. This permanently removes the targeted resource. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `branch` | string ("matched" | "unmatched" | "both") | No | Optional branch to remove. One of `matched`, `unmatched`, or `both` (default). |
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an empty Funnel

**Slug:** `CLICKFUNNELS_DESTROY_FUNNELS`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Split Test Step

**Slug:** `CLICKFUNNELS_DESTROY_FUNNEL_SPLIT_TEST_STEP`

Destroy Split Test Step. This permanently removes the targeted resource. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `branch` | string ("left" | "right" | "both") | No | Optional branch to remove. One of `left`, `right`, or `both` (default). |
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Refine Filter

**Slug:** `CLICKFUNNELS_DESTROY_REFINE_FILTER`

Destroy 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Public id of the RefineFilter to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable Workflow

**Slug:** `CLICKFUNNELS_DISABLE_WORKFLOW`

Disable Workflow. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Dismiss Reports on Post

**Slug:** `CLICKFUNNELS_DISMISS_REPORTS_COMMUNITIES_SPACES_POST`

Dismiss 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Dismiss Comment Reports

**Slug:** `CLICKFUNNELS_DISMISS_REPORTS_COMMUNITIES_SPACES_POSTS_COMMENT`

Dismiss 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable Workflow

**Slug:** `CLICKFUNNELS_ENABLE_WORKFLOW`

Enable Workflow. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Redact Contact

**Slug:** `CLICKFUNNELS_GDPR_DESTROY_CONTACTS`

Redact Contact. This permanently removes the targeted resource. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate a Contact Filter

**Slug:** `CLICKFUNNELS_GENERATE_CONTACT_FILTER`

Generate 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Country

**Slug:** `CLICKFUNNELS_GET_ADDRESSES_COUNTRIES`

Get Country. API access tokens need reference:read or reference:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The country's ISO 3166-1 alpha-2 code (e.g. "US"). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Blog

**Slug:** `CLICKFUNNELS_GET_BLOG`

Fetch Blog. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Blog Author

**Slug:** `CLICKFUNNELS_GET_BLOG_AUTHOR`

Fetch Blog Author. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Blog Category

**Slug:** `CLICKFUNNELS_GET_BLOG_CATEGORY`

Fetch Blog Category. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Blog Post

**Slug:** `CLICKFUNNELS_GET_BLOG_POST`

Fetch Blog Post. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `expand__` | array | No | 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](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Blog Tag

**Slug:** `CLICKFUNNELS_GET_BLOG_TAG`

Fetch Blog Tag. API access tokens need blog:read or blog:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Community

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES`

Fetch Community. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Ban

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_BANS`

Fetch Ban. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Ban Export Action

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_BANS_EXPORT_ACTIONS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Ban Unban Action

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_BANS_UNBAN_ACTIONS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Membership

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_MEMBERSHIPS`

Fetch Membership. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Membership Add-To-Group Action

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_MEMBERSHIPS_ADD_TO_GROUP_ACTIONS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Membership Ban Action

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_MEMBERSHIPS_BAN_ACTIONS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Membership Export Action

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_MEMBERSHIPS_EXPORT_ACTIONS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Membership Remove-From-Group Action

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_MEMBERSHIPS_REMOVE_FROM_GROUP_ACTIONS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Space Group

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_SPACE_GROUPS`

Fetch Space Group. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Space

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_SPACES`

Fetch Space. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Post

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_SPACES_POSTS`

Fetch Post. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Comment

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_SPACES_POSTS_COMMENTS`

Fetch Comment. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Video Embed

**Slug:** `CLICKFUNNELS_GET_COMMUNITIES_SPACES_POSTS_VIDEO_EMBEDS`

Fetch Video Embed. API access tokens need community:read or community:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a Contact Filter

**Slug:** `CLICKFUNNELS_GET_CONTACT_FILTER`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The saved filter's `id` or `public_id`. |
| `results` | string | No | Return projected matches inline. Pass `true` for ids only; omit for the filter definition alone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Contact

**Slug:** `CLICKFUNNELS_GET_CONTACTS`

Fetch Contact. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `expand__` | array | No | Expand additional data in the response. Use `expand[]=field_name` to include optional fields (e.g., `expand[]=email_engagement`). See the [Expanding guide](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Applied Tag

**Slug:** `CLICKFUNNELS_GET_CONTACTS_APPLIED_TAGS`

Fetch Applied Tag. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get contact billing address

**Slug:** `CLICKFUNNELS_GET_CONTACTS_BILLING_ADDRESS`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Enroll Action

**Slug:** `CLICKFUNNELS_GET_CONTACTS_ENROLL_ACTIONS`

Fetch Enroll Action. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Contact Event

**Slug:** `CLICKFUNNELS_GET_CONTACTS_EVENTS`

Fetch Contact Event. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Contact Activity Note

**Slug:** `CLICKFUNNELS_GET_CONTACTS_EVENTS_NOTES`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Export Action

**Slug:** `CLICKFUNNELS_GET_CONTACTS_EXPORT_ACTIONS`

Fetch Export Action. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Run Workflow Action

**Slug:** `CLICKFUNNELS_GET_CONTACTS_RUN_WORKFLOW_ACTIONS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Contact Subscription Change

**Slug:** `CLICKFUNNELS_GET_CONTACTS_SUBSCRIPTION_CHANGES`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Tag Action

**Slug:** `CLICKFUNNELS_GET_CONTACTS_TAG_ACTIONS`

Fetch Tag Action. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Tag

**Slug:** `CLICKFUNNELS_GET_CONTACTS_TAGS`

Fetch Tag. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Unsubscribe Action

**Slug:** `CLICKFUNNELS_GET_CONTACTS_UNSUBSCRIBE_ACTIONS`

Fetch Unsubscribe Action. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Contact Topic Opt-out

**Slug:** `CLICKFUNNELS_GET_CONTACTS_UNSUBSCRIBED_TOPICS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Course

**Slug:** `CLICKFUNNELS_GET_COURSES`

Fetch Course. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Enrollment

**Slug:** `CLICKFUNNELS_GET_COURSES_ENROLLMENTS`

Fetch Enrollment. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Lesson Completion

**Slug:** `CLICKFUNNELS_GET_COURSES_LESSON_COMPLETIONS`

Fetch Lesson Completion. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Lesson

**Slug:** `CLICKFUNNELS_GET_COURSES_LESSONS`

Fetch Lesson. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Section

**Slug:** `CLICKFUNNELS_GET_COURSES_SECTIONS`

Fetch Section. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Publish Action

**Slug:** `CLICKFUNNELS_GET_COURSES_SECTIONS_PUBLISH_ACTIONS`

Fetch Publish Action. API access tokens need courses:read or courses:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch My User

**Slug:** `CLICKFUNNELS_GET_CURRENT_USER`

Fetch My User. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Discount

**Slug:** `CLICKFUNNELS_GET_DISCOUNTS`

Fetch Discount. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Domain

**Slug:** `CLICKFUNNELS_GET_DOMAIN`

Fetch Domain. API access tokens need sites:read or sites:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Download

**Slug:** `CLICKFUNNELS_GET_DOWNLOADS`

Fetch Download. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Address

**Slug:** `CLICKFUNNELS_GET_EMAILS_ADDRESSES`

Get Email Address. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Email Broadcast

**Slug:** `CLICKFUNNELS_GET_EMAILS_BROADCAST`

Fetch Email Broadcast. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Send Action

**Slug:** `CLICKFUNNELS_GET_EMAILS_BROADCASTS_SEND_ACTIONS`

Fetch Send Action. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Email Broadcast Stats

**Slug:** `CLICKFUNNELS_GET_EMAILS_BROADCAST_STATS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `broadcast_id` | string | Yes | Identifier used for the broadcast id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Domain

**Slug:** `CLICKFUNNELS_GET_EMAILS_DOMAINS`

Get Email Domain. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Settings

**Slug:** `CLICKFUNNELS_GET_EMAILS_SETTINGS`

Get Email Settings. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Email Template

**Slug:** `CLICKFUNNELS_GET_EMAILS_TEMPLATE`

Fetch Email Template. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Email Topic

**Slug:** `CLICKFUNNELS_GET_EMAILS_TOPIC`

Fetch Email Topic. API access tokens need emails:read or emails:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Form

**Slug:** `CLICKFUNNELS_GET_FORMS`

Fetch Form. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Field

**Slug:** `CLICKFUNNELS_GET_FORMS_FIELDS`

Fetch Field. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Field Set

**Slug:** `CLICKFUNNELS_GET_FORMS_FIELD_SETS`

Fetch Field Set. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Option

**Slug:** `CLICKFUNNELS_GET_FORMS_FIELDS_OPTIONS`

Fetch Option. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Submission

**Slug:** `CLICKFUNNELS_GET_FORMS_SUBMISSIONS`

Fetch Submission. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Answer

**Slug:** `CLICKFUNNELS_GET_FORMS_SUBMISSIONS_ANSWERS`

Fetch Answer. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Form Submission

**Slug:** `CLICKFUNNELS_GET_FORM_SUBMISSIONS`

Fetch Form Submission. API access tokens need forms:read or forms:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Fulfillment

**Slug:** `CLICKFUNNELS_GET_FULFILLMENTS`

Fetch Fulfillment. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Location

**Slug:** `CLICKFUNNELS_GET_FULFILLMENTS_LOCATIONS`

Fetch Location. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Conditional Split Step

**Slug:** `CLICKFUNNELS_GET_FUNNEL_CONDITIONAL_SPLIT_STEP`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Funnel

**Slug:** `CLICKFUNNELS_GET_FUNNELS`

Fetch Funnel. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `expand__` | array | No | Expand additional data in the response. Use `expand[]=field_name` to include optional fields. Available fields: head_code, footer_code. See the [Expanding guide](https://developers.myclickfunnels.com/docs/expand) for examples. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Funnel Clone Action

**Slug:** `CLICKFUNNELS_GET_FUNNELS_CLONE_ACTIONS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Split Test Step

**Slug:** `CLICKFUNNELS_GET_FUNNEL_SPLIT_TEST_STEP`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Tag

**Slug:** `CLICKFUNNELS_GET_FUNNELS_TAGS`

Fetch Tag. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Funnel Stats

**Slug:** `CLICKFUNNELS_GET_FUNNEL_STATS`

Fetch Funnel Stats. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand__` | array | No | 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](https://accounts.myclickfunnels.com/.well-known/stats/skill.md#response-with-expandsteps) in the [Stats Skill](https://accounts.myclickfunnels.com/.well-known/stats/skill.md) for both response shapes. |
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |
| `timerange_end` | string | No | 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. |
| `timerange_start` | string | No | 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)](https://accounts.myclickfunnels.com/.well-known/stats/skill.md#timerange-parameters-both-endpoints) in the [Stats Skill](https://accounts.myclickfunnels.com/.well-known/stats/skill.md) for the clamping rules and how to cover longer windows. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Funnel Structure

**Slug:** `CLICKFUNNELS_GET_FUNNEL_STRUCTURE`

Fetch Funnel Structure. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Image

**Slug:** `CLICKFUNNELS_GET_IMAGES`

Fetch Image. API access tokens need media:read or media:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Order

**Slug:** `CLICKFUNNELS_GET_ORDERS`

Fetch Order. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Applied Tag

**Slug:** `CLICKFUNNELS_GET_ORDERS_APPLIED_TAGS`

Fetch Applied Tag. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Invoice

**Slug:** `CLICKFUNNELS_GET_ORDERS_INVOICES`

Fetch Invoice. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Tag

**Slug:** `CLICKFUNNELS_GET_ORDERS_TAGS`

Fetch Tag. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Transaction

**Slug:** `CLICKFUNNELS_GET_ORDERS_TRANSACTIONS`

Fetch Transaction. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Custom HTML Page Body

**Slug:** `CLICKFUNNELS_GET_PAGE_CUSTOM_HTML`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Page

**Slug:** `CLICKFUNNELS_GET_PAGES`

Fetch Page. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `expand` | array | No | 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](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. Read a page's existing markup with `expand[]=markup` before editing it: see [Reading Current Markup](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#reading-current-markup) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Page Stats

**Slug:** `CLICKFUNNELS_GET_PAGE_STATS`

Fetch Page Stats. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | Identifier used for the page id path segment. |
| `timerange_end` | string | No | 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. |
| `timerange_start` | string | No | 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)](https://accounts.myclickfunnels.com/.well-known/stats/skill.md#timerange-parameters-both-endpoints) in the [Stats Skill](https://accounts.myclickfunnels.com/.well-known/stats/skill.md) for the clamping rules and how to cover longer windows. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Product

**Slug:** `CLICKFUNNELS_GET_PRODUCTS`

Fetch Product. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Collection

**Slug:** `CLICKFUNNELS_GET_PRODUCTS_COLLECTIONS`

Fetch Collection. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Price

**Slug:** `CLICKFUNNELS_GET_PRODUCTS_PRICES`

Fetch Price. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Tag

**Slug:** `CLICKFUNNELS_GET_PRODUCTS_TAGS`

Fetch Tag. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Variant

**Slug:** `CLICKFUNNELS_GET_PRODUCTS_VARIANTS`

Fetch Variant. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Refine Filter

**Slug:** `CLICKFUNNELS_GET_REFINE_FILTER`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Public id of the RefineFilter (e.g. `AbCdEf`). |
| `results` | string | No | Return projected matches inline. Pass `true` for ids only; omit for the filter definition alone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Restock

**Slug:** `CLICKFUNNELS_GET_RESTOCK`

Fetch Restock. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Opportunity

**Slug:** `CLICKFUNNELS_GET_SALES_OPPORTUNITIES`

Fetch Opportunity. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Note

**Slug:** `CLICKFUNNELS_GET_SALES_OPPORTUNITIES_NOTES`

Fetch Note. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Pipeline

**Slug:** `CLICKFUNNELS_GET_SALES_PIPELINES`

Fetch Pipeline. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Stage

**Slug:** `CLICKFUNNELS_GET_SALES_PIPELINES_STAGES`

Fetch Stage. API access tokens need opportunities:read or opportunities:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Segment

**Slug:** `CLICKFUNNELS_GET_SEGMENTS`

Fetch Segment. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `results` | string | No | Return matching contacts inline; omit for the audience definition alone. Requires contacts:read. Count is opt-in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get shipping addresses

**Slug:** `CLICKFUNNELS_GET_SHIPPING_ADDRESSES`

Get shipping addresses. API access tokens need contacts:read or contacts:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Location Group

**Slug:** `CLICKFUNNELS_GET_SHIPPING_LOCATION_GROUPS`

Fetch Location Group. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Package

**Slug:** `CLICKFUNNELS_GET_SHIPPING_PACKAGES`

Fetch Package. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Profile

**Slug:** `CLICKFUNNELS_GET_SHIPPING_PROFILES`

Fetch Profile. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Rate

**Slug:** `CLICKFUNNELS_GET_SHIPPING_RATES`

Fetch Rate. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Name

**Slug:** `CLICKFUNNELS_GET_SHIPPING_RATES_NAMES`

Fetch Name. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Zone

**Slug:** `CLICKFUNNELS_GET_SHIPPING_ZONES`

Fetch Zone. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Site

**Slug:** `CLICKFUNNELS_GET_SITE`

Fetch Site. API access tokens need sites:read or sites:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand__` | array | No | 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](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Store

**Slug:** `CLICKFUNNELS_GET_STORES`

Fetch Store. API access tokens need store:read or store:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Team

**Slug:** `CLICKFUNNELS_GET_TEAM`

Fetch Team. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Theme

**Slug:** `CLICKFUNNELS_GET_THEMES`

Fetch Theme. API access tokens need sites:read or sites:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Short Link Availability

**Slug:** `CLICKFUNNELS_GET_URL_REDIRECT_AVAILABILITY`

Check Short Link Availability. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_id` | string | No | Workspace domain numeric/public ID; omitted or 0 selects the default domain. Invalid or foreign domains return 422. |
| `current_path` | string | Yes | Plain URL-encoded path to check. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `url_redirect_id` | string | No | Optional same-workspace short link numeric/public ID being edited. Missing or foreign records return 404. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Short Link

**Slug:** `CLICKFUNNELS_GET_URL_REDIRECTS`

Fetch Short Link. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Short Link Stats

**Slug:** `CLICKFUNNELS_GET_URL_REDIRECT_STATS`

Fetch Short Link Stats. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `timerange_end` | string | No | Value for the timerange end query filter. |
| `timerange_start` | string | No | Value for the timerange start query filter. |
| `url_redirect_id` | string | Yes | Identifier used for the url redirect id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch User

**Slug:** `CLICKFUNNELS_GET_USER`

Fetch User. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Incoming External Purchase Endpoint

**Slug:** `CLICKFUNNELS_GET_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_ENDPOINTS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Incoming External Purchase Event

**Slug:** `CLICKFUNNELS_GET_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_EVENTS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Incoming External Purchase Product Mapping

**Slug:** `CLICKFUNNELS_GET_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_PRODUCT_MAPPINGS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Endpoint

**Slug:** `CLICKFUNNELS_GET_WEBHOOKS_OUTGOING_ENDPOINTS`

Fetch Endpoint. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Event

**Slug:** `CLICKFUNNELS_GET_WEBHOOKS_OUTGOING_EVENTS`

Fetch Event. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Workflow

**Slug:** `CLICKFUNNELS_GET_WORKFLOW`

Fetch Workflow. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Run

**Slug:** `CLICKFUNNELS_GET_WORKFLOW_RUN`

Fetch Run. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Step

**Slug:** `CLICKFUNNELS_GET_WORKFLOW_STEP`

Fetch Step. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Workflow Step Stats

**Slug:** `CLICKFUNNELS_GET_WORKFLOW_STEP_STATS`

Fetch 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `step_id` | string | Yes | Identifier used for the step id path segment. |
| `timerange_end` | string | No | 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. |
| `timerange_start` | string | No | 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)](https://accounts.myclickfunnels.com/.well-known/stats/skill.md#timerange-parameters-both-endpoints) in the [Stats Skill](https://accounts.myclickfunnels.com/.well-known/stats/skill.md) for the clamping rules and how to cover longer windows. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Workflow Structure

**Slug:** `CLICKFUNNELS_GET_WORKFLOW_STRUCTURE`

Fetch Workflow Structure. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Trigger

**Slug:** `CLICKFUNNELS_GET_WORKFLOW_TRIGGER`

Fetch Trigger. API access tokens need workflows:read or workflows:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Workspace

**Slug:** `CLICKFUNNELS_GET_WORKSPACES`

Fetch Workspace. API access tokens need account:read or account:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Workspace Stats

**Slug:** `CLICKFUNNELS_GET_WORKSPACE_STATS`

Fetch Workspace Stats. Because one call can select Contacts, Store, or Forms records, API access tokens need coarse read or write permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sum` | object | No | Totals one allow-listed numeric property. Exact; listed in `unavailable` instead when it cannot finish in time. Not available for every resource. |
| `count` | boolean | No | 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. |
| `filter` | object | No | 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. |
| `count_by` | object | No | Breaks the matching set down by one allow-listed property, returning a count per distinct value. |
| `resource` | string ("contact" | "order" | "form_submission") | Yes | The resource to report on. |
| `stable_id` | string | No | 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). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `created_at_range` | boolean | No | The earliest and latest `created_at` in the matching set. Exact; listed in `unavailable` instead when it cannot finish in time. |
| `stored_filter_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Countries

**Slug:** `CLICKFUNNELS_LIST_ADDRESSES_COUNTRIES`

List Countries. API access tokens need reference:read or reference:write permission; the coarse read or write permission also authorizes this action.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Country Regions

**Slug:** `CLICKFUNNELS_LIST_ADDRESSES_COUNTRIES_REGIONS`

List Country Regions. API access tokens need reference:read or reference:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_id` | string | Yes | The country's ISO 3166-1 alpha-2 code (e.g. "US"). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Scheduled Events

**Slug:** `CLICKFUNNELS_LIST_APPOINTMENTS_SCHEDULED_EVENTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blogs

**Slug:** `CLICKFUNNELS_LIST_BLOGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blog Authors

**Slug:** `CLICKFUNNELS_LIST_BLOGS_AUTHORS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `blog_id` | string | Yes | Identifier used for the blog id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blog Categories

**Slug:** `CLICKFUNNELS_LIST_BLOGS_CATEGORIES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `blog_id` | string | Yes | Identifier used for the blog id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blog Posts

**Slug:** `CLICKFUNNELS_LIST_BLOGS_POSTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `blog_id` | string | Yes | Identifier used for the blog id path segment. |
| `expand__` | array | No | 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](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blog Tags

**Slug:** `CLICKFUNNELS_LIST_BLOGS_TAGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `blog_id` | string | Yes | Identifier used for the blog id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Communities

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bans

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_BANS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `community_id` | string | Yes | Identifier used for the community id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ban Export Actions

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_BANS_EXPORT_ACTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `community_id` | string | Yes | Identifier used for the community id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Memberships

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_MEMBERSHIPS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `community_id` | string | Yes | Identifier used for the community id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Membership Export Actions

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_MEMBERSHIPS_EXPORT_ACTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `community_id` | string | Yes | Identifier used for the community id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Space Groups

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_SPACE_GROUPS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `community_id` | string | Yes | Identifier used for the community id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Spaces

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_SPACES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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. |
| `space_group_id` | string | Yes | Identifier used for the space group id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Posts

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_SPACES_POSTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `space_id` | string | Yes | Identifier used for the space id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Comments

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_SPACES_POSTS_COMMENTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `post_id` | string | Yes | Identifier used for the post id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Comment Likes

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_SPACES_POSTS_COMMENTS_LIKES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `comment_id` | string | Yes | Identifier used for the comment id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Post Likes

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_SPACES_POSTS_LIKES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `post_id` | string | Yes | Identifier used for the post id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Video Embeds

**Slug:** `CLICKFUNNELS_LIST_COMMUNITIES_SPACES_POSTS_VIDEO_EMBEDS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `post_id` | string | Yes | Identifier used for the post id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `CLICKFUNNELS_LIST_CONTACTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `expand__` | array | No | Expand additional data in the response. Use `expand[]=field_name` to include optional fields (e.g., `expand[]=email_engagement`). See the [Expanding guide](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `stable_id` | string | No | 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. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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. |
| `stored_filter_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Applied Tags

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_APPLIED_TAGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Enroll Actions

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_ENROLL_ACTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Events

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_EVENTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | Value for the filter query filter. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Activity Notes

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_EVENTS_NOTES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Export Actions

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_EXPORT_ACTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Run Workflow Actions

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_RUN_WORKFLOW_ACTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Subscription Changes

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_SUBSCRIPTION_CHANGES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tag Actions

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_TAG_ACTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_TAGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Unsubscribe Actions

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_UNSUBSCRIBE_ACTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Topic Opt-outs

**Slug:** `CLICKFUNNELS_LIST_CONTACTS_UNSUBSCRIBED_TOPICS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Courses

**Slug:** `CLICKFUNNELS_LIST_COURSES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Enrollments

**Slug:** `CLICKFUNNELS_LIST_COURSES_ENROLLMENTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | The provider's filter value. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `course_id` | string | Yes | Identifier used for the course id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lesson Completions

**Slug:** `CLICKFUNNELS_LIST_COURSES_LESSON_COMPLETIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | The provider's filter value. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `course_id` | string | Yes | Identifier used for the course id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lessons

**Slug:** `CLICKFUNNELS_LIST_COURSES_LESSONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `section_id` | string | Yes | Identifier used for the section id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at" | "sort_order") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sections

**Slug:** `CLICKFUNNELS_LIST_COURSES_SECTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `course_id` | string | Yes | Identifier used for the course id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at" | "sort_order") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Publish Actions

**Slug:** `CLICKFUNNELS_LIST_COURSES_SECTIONS_PUBLISH_ACTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `course_id` | string | Yes | Identifier used for the course id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Discounts

**Slug:** `CLICKFUNNELS_LIST_DISCOUNTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | The provider's filter value. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Domains

**Slug:** `CLICKFUNNELS_LIST_DOMAINS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Downloads

**Slug:** `CLICKFUNNELS_LIST_DOWNLOADS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Addresses

**Slug:** `CLICKFUNNELS_LIST_EMAILS_ADDRESSES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Broadcasts

**Slug:** `CLICKFUNNELS_LIST_EMAILS_BROADCASTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Send Actions

**Slug:** `CLICKFUNNELS_LIST_EMAILS_BROADCASTS_SEND_ACTIONS`

List Send Actions. 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `broadcast_id` | string | Yes | Identifier used for the broadcast id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Domains

**Slug:** `CLICKFUNNELS_LIST_EMAILS_DOMAINS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Templates

**Slug:** `CLICKFUNNELS_LIST_EMAILS_TEMPLATES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Topics

**Slug:** `CLICKFUNNELS_LIST_EMAILS_TOPICS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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. |
| `include_archived` | boolean | No | Set to true to include archived topics in the results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Forms

**Slug:** `CLICKFUNNELS_LIST_FORMS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Fields

**Slug:** `CLICKFUNNELS_LIST_FORMS_FIELDS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `field_set_id` | string | Yes | Identifier used for the field set id path segment. |
| `sort_property` | string ("id" | "updated_at" | "sort_order") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Field Sets

**Slug:** `CLICKFUNNELS_LIST_FORMS_FIELD_SETS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `form_id` | string | Yes | Identifier used for the form id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Options

**Slug:** `CLICKFUNNELS_LIST_FORMS_FIELDS_OPTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `field_id` | string | Yes | Identifier used for the field id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at" | "sort_order") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Submissions

**Slug:** `CLICKFUNNELS_LIST_FORMS_SUBMISSIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `form_id` | string | Yes | Identifier used for the form id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Answers

**Slug:** `CLICKFUNNELS_LIST_FORMS_SUBMISSIONS_ANSWERS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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. |
| `submission_id` | string | Yes | Identifier used for the submission id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Form Submissions

**Slug:** `CLICKFUNNELS_LIST_FORM_SUBMISSIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Fulfillments

**Slug:** `CLICKFUNNELS_LIST_FULFILLMENTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Locations

**Slug:** `CLICKFUNNELS_LIST_FULFILLMENTS_LOCATIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at" | "sort_order") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Conditional Split Steps

**Slug:** `CLICKFUNNELS_LIST_FUNNEL_CONDITIONAL_SPLIT_STEPS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Pass `filter` to include the full RefineFilter object in `condition.filter` for each step. |
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Funnels

**Slug:** `CLICKFUNNELS_LIST_FUNNELS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `expand__` | array | No | Expand additional data in the response. Use `expand[]=field_name` to include optional fields. Available fields: head_code, footer_code. See the [Expanding guide](https://developers.myclickfunnels.com/docs/expand) for examples. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Funnel Clone Actions

**Slug:** `CLICKFUNNELS_LIST_FUNNELS_CLONE_ACTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `funnel_id` | string | Yes | Source funnel integer ID or public ID |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Split Test Steps

**Slug:** `CLICKFUNNELS_LIST_FUNNEL_SPLIT_TEST_STEPS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `CLICKFUNNELS_LIST_FUNNELS_TAGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Images

**Slug:** `CLICKFUNNELS_LIST_IMAGES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orders

**Slug:** `CLICKFUNNELS_LIST_ORDERS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `stable_id` | string | No | 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](https://accounts.myclickfunnels.com/.well-known/refine-filters/skill.md#applying-existing-order-filters) in the [Refine Filters Skill](https://accounts.myclickfunnels.com/.well-known/refine-filters/skill.md) for where to copy and send the token. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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. |
| `stored_filter_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Applied Tags

**Slug:** `CLICKFUNNELS_LIST_ORDERS_APPLIED_TAGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `order_id` | string | Yes | Identifier used for the order id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invoices

**Slug:** `CLICKFUNNELS_LIST_ORDERS_INVOICES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `order_id` | string | Yes | Identifier used for the order id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `CLICKFUNNELS_LIST_ORDERS_TAGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Transactions

**Slug:** `CLICKFUNNELS_LIST_ORDERS_TRANSACTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `order_id` | string | Yes | Identifier used for the order id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pages

**Slug:** `CLICKFUNNELS_LIST_PAGES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `expand` | array | No | 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](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. Read a page's existing markup with `expand[]=markup` before editing it: see [Reading Current Markup](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#reading-current-markup) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md). |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products

**Slug:** `CLICKFUNNELS_LIST_PRODUCTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Collections

**Slug:** `CLICKFUNNELS_LIST_PRODUCTS_COLLECTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prices

**Slug:** `CLICKFUNNELS_LIST_PRODUCTS_PRICES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `product_id` | string | Yes | Identifier used for the product id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Upgrade/Downgrade Options

**Slug:** `CLICKFUNNELS_LIST_PRODUCTS_PRICES_CHANGE_OPTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `price_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `CLICKFUNNELS_LIST_PRODUCTS_TAGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Variants

**Slug:** `CLICKFUNNELS_LIST_PRODUCTS_VARIANTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `product_id` | string | Yes | Identifier used for the product id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Restocks

**Slug:** `CLICKFUNNELS_LIST_RESTOCKS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Opportunities

**Slug:** `CLICKFUNNELS_LIST_SALES_OPPORTUNITIES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at" | "sort_order") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notes

**Slug:** `CLICKFUNNELS_LIST_SALES_OPPORTUNITIES_NOTES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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. |
| `opportunity_id` | string | Yes | Identifier used for the opportunity id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipelines

**Slug:** `CLICKFUNNELS_LIST_SALES_PIPELINES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stages

**Slug:** `CLICKFUNNELS_LIST_SALES_PIPELINES_STAGES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `pipeline_id` | string | Yes | Identifier used for the pipeline id path segment. |
| `sort_property` | string ("id" | "updated_at" | "sort_order") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Segments

**Slug:** `CLICKFUNNELS_LIST_SEGMENTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | Value for the filter query filter. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List shipping addresses

**Slug:** `CLICKFUNNELS_LIST_SHIPPING_ADDRESSES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `contact_id` | string | Yes | Contact ID |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Location Groups

**Slug:** `CLICKFUNNELS_LIST_SHIPPING_LOCATION_GROUPS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `profile_id` | string | Yes | Identifier used for the profile id path segment. |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Packages

**Slug:** `CLICKFUNNELS_LIST_SHIPPING_PACKAGES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Profiles

**Slug:** `CLICKFUNNELS_LIST_SHIPPING_PROFILES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Rates

**Slug:** `CLICKFUNNELS_LIST_SHIPPING_RATES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `zone_id` | string | Yes | Identifier used for the zone id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Names

**Slug:** `CLICKFUNNELS_LIST_SHIPPING_RATES_NAMES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Zones

**Slug:** `CLICKFUNNELS_LIST_SHIPPING_ZONES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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. |
| `location_group_id` | string | Yes | Identifier used for the location group id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stores

**Slug:** `CLICKFUNNELS_LIST_STORES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Styles

**Slug:** `CLICKFUNNELS_LIST_STYLES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Teams

**Slug:** `CLICKFUNNELS_LIST_TEAMS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Themes

**Slug:** `CLICKFUNNELS_LIST_THEMES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Short Links

**Slug:** `CLICKFUNNELS_LIST_URL_REDIRECTS`

List Short Links. Returns one page and a next cursor when more records are available. API access tokens need funnels:read or funnels:write permission; the coarse read or write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `CLICKFUNNELS_LIST_USERS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Incoming External Purchase Endpoints

**Slug:** `CLICKFUNNELS_LIST_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_ENDPOINTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | Filter by `id`, `provider` or `live_mode`, like this: `?filter[provider]=whop&filter[live_mode]=true`. All about filtering [here](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Incoming External Purchase Events

**Slug:** `CLICKFUNNELS_LIST_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_EVENTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | Filter by `id`, `event_type` or `processing_status`, like this: `?filter[event_type]=payment.succeeded&filter[processing_status]=success`. All about filtering [here](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `endpoint_id` | string | Yes | Integer ID or obfuscated public ID of the incoming external purchase endpoint. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Incoming External Purchase Product Mappings

**Slug:** `CLICKFUNNELS_LIST_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_PRODUCT_MAPPINGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at") | No | 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. |
| `external_purchases_endpoint_id` | string | Yes | Integer ID or obfuscated public ID of the incoming external purchase endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Endpoints

**Slug:** `CLICKFUNNELS_LIST_WEBHOOKS_OUTGOING_ENDPOINTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Events

**Slug:** `CLICKFUNNELS_LIST_WEBHOOKS_OUTGOING_EVENTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Event Types

**Slug:** `CLICKFUNNELS_LIST_WEBHOOKS_OUTGOING_EVENT_TYPES`

List Event Types. API access tokens need webhooks:read or webhooks:write permission; the coarse read or write permission also authorizes this action.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Runs

**Slug:** `CLICKFUNNELS_LIST_WORKFLOW_RUNS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workflow_id` | string | Yes | Integer id or obfuscated public_id of the workflow. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflows

**Slug:** `CLICKFUNNELS_LIST_WORKFLOWS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Steps

**Slug:** `CLICKFUNNELS_LIST_WORKFLOW_STEPS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workflow_id` | string | Yes | Integer id or obfuscated public_id of the workflow. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Triggers

**Slug:** `CLICKFUNNELS_LIST_WORKFLOW_TRIGGERS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workflow_id` | string | Yes | Integer id or obfuscated public_id of the workflow. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspace Contact Topic Opt-outs

**Slug:** `CLICKFUNNELS_LIST_WORKSPACE_CONTACTS_UNSUBSCRIBED_TOPICS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspace Invoices

**Slug:** `CLICKFUNNELS_LIST_WORKSPACE_ORDERS_INVOICES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `sort_property` | string ("id" | "updated_at") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Refine Filters

**Slug:** `CLICKFUNNELS_LIST_WORKSPACE_REFINE_FILTERS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | 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. |
| `filter` | object | No | 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](https://developers.myclickfunnels.com/docs/filtering). |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspaces

**Slug:** `CLICKFUNNELS_LIST_WORKSPACES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned as next_cursor by a previous call. |
| `team_id` | string | Yes | Identifier used for the team id path segment. |
| `per_page` | integer | No | 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](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_order` | string ("asc" | "desc") | No | Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). |
| `sort_property` | string ("id" | "updated_at" | "name") | No | Sort property of the workspace list. Defaults to `id`; `updated_at` and `name` are also supported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Variant/Price

**Slug:** `CLICKFUNNELS_PERFORM_ORDERS_LINE_ITEMS_CHANGE`

Change 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prorate` | boolean | No | 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. |
| `line_item_id` | string | Yes | The id of the subscription line item. Accepts either the integer database id or the obfuscated `public_id` string returned by line-item endpoints. |
| `effective_time` | string ("now" | "next_renewal") | No | 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. |
| `products_price_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pin Post

**Slug:** `CLICKFUNNELS_PIN_COMMUNITIES_SPACES_POST`

Pin Post. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview Variant/Price Change

**Slug:** `CLICKFUNNELS_PREVIEW_ORDERS_LINE_ITEMS_CHANGE`

Preview Variant/Price Change. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prorate` | boolean | No | 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. |
| `line_item_id` | string | Yes | The id of the subscription line item. Accepts either the integer database id or the obfuscated `public_id` string returned by line-item endpoints. |
| `effective_time` | string ("now" | "next_renewal") | No | 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. |
| `products_price_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Publish Course

**Slug:** `CLICKFUNNELS_PUBLISH_COURSE`

Publish 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `published_at` | string | No | 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. |
| `publish_sections_and_lessons` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Publish Lesson

**Slug:** `CLICKFUNNELS_PUBLISH_COURSES_LESSONS`

Publish 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `published_at` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Publish Section

**Slug:** `CLICKFUNNELS_PUBLISH_COURSES_SECTIONS`

Publish 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `published_at` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Refund Transaction

**Slug:** `CLICKFUNNELS_REFUND_ORDERS_TRANSACTIONS`

Refund 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `reason` | string | No | 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. |
| `partial` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reorder Fields

**Slug:** `CLICKFUNNELS_REORDER_FORMS_FIELDS`

Reorder Fields. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field_set_id` | string | Yes | Identifier used for the field set id path segment. |
| `ids_in_order` | array | Yes | An array of field IDs in the desired order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Default Theme

**Slug:** `CLICKFUNNELS_SET_DEFAULT_THEMES`

Set Default Theme. API access tokens need sites:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore an archived Funnel

**Slug:** `CLICKFUNNELS_UNARCHIVE_FUNNELS`

Restore 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `expand__` | array | No | Expand additional data in the response. Use `expand[]=field_name` to include optional fields. Available fields: head_code, footer_code. See the [Expanding guide](https://developers.myclickfunnels.com/docs/expand) for examples. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unarchive a Product

**Slug:** `CLICKFUNNELS_UNARCHIVE_PRODUCTS`

Unarchive a Product. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unpin Post

**Slug:** `CLICKFUNNELS_UNPIN_COMMUNITIES_SPACES_POST`

Unpin Post. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Blog

**Slug:** `CLICKFUNNELS_UPDATE_BLOG`

Update Blog. API access tokens need blog:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name of the blog |
| `theme_id` | integer | No | Theme ID for the blog |
| `seo_title` | string | No | Default Blog title for SEO |
| `seo_image_id` | integer | No | Default sharing image ID |
| `seo_description` | string | No | Default Blog description for SEO |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Blog Post

**Slug:** `CLICKFUNNELS_UPDATE_BLOG_POST`

Update Blog Post. API access tokens need blog:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `title` | string | No | Title of the post |
| `markup` | string | No | 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](https://accounts.myclickfunnels.com/.well-known/page-markup/skill.md) for the DSL, approval guardrail, and normalization rules. |
| `tag_ids` | array | No | IDs of tags to associate with the post |
| `expand__` | array | No | 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](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |
| `image_id` | integer | No | Featured image ID. When importing an article, its images need rehosting first: see [Rehost source images during a migration](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#rehost-source-images-during-a-migration) and the [image caveat](https://accounts.myclickfunnels.com/.well-known/blogs/import-external-post/skill.md#image-caveat). |
| `seo_title` | string | No | SEO page title |
| `author_ids` | array | No | IDs of authors to associate with the post |
| `visibility` | string ("draft" | "public" | "members_only" | "scheduled") | No | Visibility status. One of `draft`, `public`, `members_only`, or `scheduled`. See [Two gotchas worth knowing](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#two-gotchas-worth-knowing) in the [Blogs Skill](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md). |
| `category_ids` | array | No | IDs of categories to associate with the post |
| `published_at` | string | No | Date and time to publish the post. Required when visibility is `scheduled`. See [Publish separately](https://accounts.myclickfunnels.com/.well-known/blogs/import-external-post/skill.md#7-publish-separately) in the [Import External Blog Post Skill](https://accounts.myclickfunnels.com/.well-known/blogs/import-external-post/skill.md). |
| `excerpt_content` | string | No | Short summary of the blog post |
| `seo_description` | string | No | SEO page description |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Community

**Slug:** `CLICKFUNNELS_UPDATE_COMMUNITIES`

Update Community. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Community Name |
| `status` | string | No | Status of the community (e.g. live, draft) |
| `private` | boolean | No | Make this Community Private? |
| `seo_title` | string | No | Seo Title |
| `invite_only` | boolean | No | Invite Only? |
| `upgrade_url` | string | No | Upgrade URL |
| `white_label` | boolean | No | Enable White Label |
| `current_path` | string | No | Current Path |
| `logo_image_id` | integer | No | Logo Image ID |
| `notifications` | string | No | Notification settings (e.g. all, essential, off) |
| `seo_indexable` | boolean | No | Seo Indexable? |
| `seo_description` | string | No | Seo Description |
| `social_image_id` | integer | No | Social Image ID |
| `anyone_can_invite` | boolean | No | Anyone Can Invite? |
| `enable_block_list` | boolean | No | Enable Block List? |
| `send_digest_email` | boolean | No | Send Digest Email? |
| `allow_public_signup` | boolean | No | Allow Public Sign-Up? |
| `send_membership_email` | boolean | No | Send Membership Email? |
| `require_post_approvals` | boolean | No | Require Post Approvals? |
| `require_comment_approvals` | boolean | No | Require Comment Approvals? |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Membership

**Slug:** `CLICKFUNNELS_UPDATE_COMMUNITIES_MEMBERSHIPS`

Update Membership. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `moderator` | boolean | No | Whether this member should have moderator privileges |
| `space_ids` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Space Group

**Slug:** `CLICKFUNNELS_UPDATE_COMMUNITIES_SPACE_GROUPS`

Update Space Group. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name |
| `emoji` | string | No | Emoji icon for the group |
| `access` | integer | No | Access level (0 = open, 1 = private, 2 = secret) |
| `always_on` | boolean | No | Always On |
| `is_hidden` | boolean | No | Only show joined Topics |
| `group_type` | integer | No | Group type (integer enum) |
| `sort_order` | integer | No | Sort order within the community |
| `description` | string | No | Description |
| `upgrade_url` | string | No | Upgrade URL |
| `current_path` | string | No | Current Path |
| `card_image_id` | integer | No | Card Image ID |
| `approval_terms` | string | No | Approval Terms |
| `auto_add_to_spaces` | boolean | No | Automatically add members to new Topics within this Group |
| `require_post_approvals` | boolean | No | Require approvals for posts in this Group? |
| `require_comment_approvals` | boolean | No | Require approvals for comments in this Group? |
| `is_hidden_from_non_members` | boolean | No | Hide from non-members |
| `require_post_approvals_override` | boolean | No | Override community-level post approval setting for this group |
| `require_comment_approvals_override` | boolean | No | Override community-level comment approval setting for this group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Space

**Slug:** `CLICKFUNNELS_UPDATE_COMMUNITIES_SPACES`

Update Space. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name |
| `emoji` | string | No | Emoji icon for the space |
| `access` | integer | No | Access level (0 = open, 1 = private, 2 = secret) |
| `always_on` | boolean | No | Always On |
| `seo_title` | string | No | Seo Title |
| `sort_order` | integer | No | Sort order within the space group |
| `default_tab` | string | No | Default tab shown when viewing the space |
| `upgrade_url` | string | No | Upgrade URL |
| `current_path` | string | No | Current Path |
| `layout_style` | string | No | Layout style for the space |
| `card_image_id` | integer | No | Card Image ID |
| `seo_description` | string | No | Seo Description |
| `social_image_id` | integer | No | Social Image ID |
| `members_can_post` | boolean | No | Whether members can post in this space |
| `allow_post_titles` | boolean | No | Whether posts can have titles |
| `default_post_sort` | string | No | Default sort order for posts |
| `allow_cover_images` | boolean | No | Whether posts can have cover images |
| `hide_from_featured` | boolean | No | Whether to hide this space from the featured spaces list |
| `members_can_invite` | boolean | No | Whether members can invite others to this space |
| `pinned_posts_label` | string | No | Label for pinned posts section |
| `default_member_sort` | string | No | Default sort order for members |
| `default_comment_sort` | string | No | Default sort order for comments |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Post

**Slug:** `CLICKFUNNELS_UPDATE_COMMUNITIES_SPACES_POSTS`

Update Post. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `body` | string | No | Post body as rich HTML |
| `title` | string | No | Post title |
| `image_id` | integer | No | Cover image ID |
| `is_pinned` | boolean | No | Whether to pin the post at the top of the space |
| `current_path` | string | No | Current path (used for tracking purposes) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Comment

**Slug:** `CLICKFUNNELS_UPDATE_COMMUNITIES_SPACES_POSTS_COMMENTS`

Update Comment. API access tokens need community:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `body` | string | No | Comment body as rich HTML |
| `skip_notifications` | boolean | No | When true, suppresses email/push notifications for this comment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact

**Slug:** `CLICKFUNNELS_UPDATE_CONTACTS`

Update Contact. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `fb_url` | string | No | Facebook URL |
| `tag_ids` | array | No | 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). |
| `expand__` | array | No | Expand additional data in the response. Use `expand[]=field_name` to include optional fields (e.g., `expand[]=email_engagement`). See the [Expanding guide](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |
| `last_name` | string | No | Last name |
| `time_zone` | string | No | 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.](https://dash.readme.com/project/cf2/v2/docs/timezones). |
| `first_name` | string | No | First name |
| `twitter_url` | string | No | Twitter URL |
| `website_url` | string | No | Website URL |
| `linkedin_url` | string | No | LinkedIn URL |
| `phone_number` | string | No | Phone number |
| `email_address` | string | No | Email address |
| `instagram_url` | string | No | Instagram URL |
| `custom_attributes` | object | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update contact billing address

**Slug:** `CLICKFUNNELS_UPDATE_CONTACTS_BILLING_ADDRESS`

Update contact billing address. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City |
| `region` | string | No | State code or full region name for the country; unknown values return 422 |
| `contact_id` | string | Yes | Identifier used for the contact id path segment. |
| `address_one` | string | No | Street line 1 |
| `address_two` | string | No | Street line 2 |
| `postal_code` | string | No | Postal code, at most 10 characters |
| `country_code` | string | No | ISO2 country code; unknown values return 422 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact Activity Note

**Slug:** `CLICKFUNNELS_UPDATE_CONTACTS_EVENTS_NOTES`

Update Contact Activity Note. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `content` | string | No | Required nonblank text on creation; no length cap. |
| `occurred_at` | string | No | Optional ISO 8601 timestamp. Defaults to server time on creation; omission on update preserves its occurrence time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tag

**Slug:** `CLICKFUNNELS_UPDATE_CONTACTS_TAGS`

Update Tag. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Tag Name |
| `color` | string | No | Tag Color |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Course

**Slug:** `CLICKFUNNELS_UPDATE_COURSES`

Update Course. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `title` | string | No | Title |
| `image_id` | integer | No | The ID of an Image to show on the storefront of the main course page |
| `description` | string | No | Description |
| `show_in_community` | boolean | No | Show In Customer Center? |
| `redirect_to_full_course` | boolean | No | Redirect To Full Course |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Enrollment

**Slug:** `CLICKFUNNELS_UPDATE_COURSES_ENROLLMENTS`

Update Enrollment. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `suspended` | boolean | No | Suspended |
| `suspension_reason` | string | No | Suspension Reason |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Lesson

**Slug:** `CLICKFUNNELS_UPDATE_COURSES_LESSONS`

Update Lesson. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `body` | string | No | Description |
| `title` | string | No | Title |
| `image_id` | string | No | Public ID of an image in the workspace to use as the lesson image. |
| `lesson_content` | string | No | Markdown lesson content. This is the primary content field for the lesson body. It is Markdown, not PML. See [Lessons](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#lessons) in the [Courses Skill](https://accounts.myclickfunnels.com/.well-known/courses/skill.md). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Section

**Slug:** `CLICKFUNNELS_UPDATE_COURSES_SECTIONS`

Update Section. API access tokens need courses:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `title` | string | No | Title |
| `description` | string | No | Description |
| `blocker_lesson_id` | integer | No | Blocker lesson |
| `blocker_section_id` | integer | No | Blocker section |
| `days_till_drip_access` | integer | No | Days until drip access |
| `is_hidden_from_non_members` | boolean | No | Current Path |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Discount

**Slug:** `CLICKFUNNELS_UPDATE_DISCOUNTS`

Update Discount. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `code` | string | No | Letters, numbers and hyphens only. Uppercased on save; must be unique within the workspace. |
| `name` | string | No | Value for the name request field. |
| `amount` | string | No | Value for the amount request field. |
| `expired` | boolean | No | 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". |
| `percent` | string | No | Value for the percent request field. |
| `currency` | string | No | ISO currency code. Locked once the discount has been applied to an order. |
| `applies_to` | string ("all_products" | "specific_products" | "specific_variants" | "specific_collections") | No | Value for the applies to request field. |
| `apply_from` | string | No | Value for the apply from request field. |
| `apply_until` | string | No | 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. |
| `product_ids` | array | No | Value for the product ids request field. |
| `variant_ids` | array | No | Value for the variant ids request field. |
| `discount_type` | string ("code" | "automatic" | "sale") | No | `code` is a redeemable coupon code. `automatic` and `sale` are deprecated. |
| `discount_method` | string ("percentage" | "fixed" | "shipping" | "bogo") | No | Value for the discount method request field. |
| `limit_1_per_customer` | boolean | No | Value for the limit 1 per customer request field. |
| `require_minimum_spend` | boolean | No | Value for the require minimum spend request field. |
| `products_collection_ids` | array | No | Value for the products collection ids request field. |
| `discounts_per_redemption` | integer | No | Value for the discounts per redemption request field. |
| `require_minimum_spend_amount` | integer | No | Minimum order subtotal, in whole currency units rather than cents - `50` on a `usd` discount means $50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Address

**Slug:** `CLICKFUNNELS_UPDATE_EMAILS_ADDRESSES`

Update Email Address. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | The from-name shown to recipients (e.g. "Acme Support"). Required when creating. |
| `label` | string | No | Optional internal label. |
| `domain` | string | No | 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. |
| `username` | string | No | The local part before the @ (e.g. "hello" for hello@yourdomain.com). Required when creating. |
| `emails_domain_id` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Broadcast

**Slug:** `CLICKFUNNELS_UPDATE_EMAILS_BROADCAST`

Update Email Broadcast. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Internal name for the broadcast |
| `send_at` | string | No | Scheduled send date |
| `subject` | string | No | Email subject line seen by recipients |
| `variants` | array | No | 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. |
| `filter_id` | string | No | 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](https://accounts.myclickfunnels.com/.well-known/refine-filters/skill.md). See [Applying filters to email broadcasts](https://accounts.myclickfunnels.com/.well-known/refine-filters/skill.md#applying-filters-to-email-broadcasts). |
| `html_body` | string | No | HTML email body |
| `text_body` | string | No | Plain text email body |
| `time_zone` | string | No | Time zone for scheduling |
| `topic_ids` | array | No | Topic IDs to associate |
| `from_email` | string | No | Sender email address. Must be a verified email address that belongs to the workspace. |
| `split_test` | boolean | No | 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. |
| `external_id` | string | No | An optional external identifier for your own tracking |
| `preheadline` | string | No | Preview text shown in email clients before opening. Maximum 150 characters. |
| `template_id` | integer | No | 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. |
| `smart_sending` | boolean | No | 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. |
| `reply_to_email` | string | No | Reply-to email address. Must be a verified address in the workspace if provided. |
| `send_at_local_time` | string | No | Scheduled send time in HH:MM:SS format |
| `smart_sending_time` | number | No | How many `smart_sending_unit`s the delivery window spans, for example `2` with `hour`. Must be between 0.5 and 100, and must be sent together with `smart_sending_unit`. Send both as `null` to go back to sizing the window from the audience. |
| `smart_sending_unit` | string ("hour" | "day") | No | 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. |
| `split_test_wait_time` | integer | No | Whole hours to wait before choosing the subject-line winner. Omit to preserve the stored value. |
| `split_test_percentage` | integer | No | Whole-number share of the audience used for the test sends. Omit to preserve the stored value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Settings

**Slug:** `CLICKFUNNELS_UPDATE_EMAILS_SETTINGS`

Update Email Settings. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Business/sender name shown on email broadcasts |
| `address` | object | No | 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. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `hide_branding` | boolean | No | Hide ClickFunnels branding in the email footer |
| `footer_alignment` | string ("left" | "center" | "right") | No | Alignment of the email footer. Any other value is rejected with a 422. |
| `unsubscribe_footer` | string | No | Custom unsubscribe footer text |
| `address_single_line` | boolean | No | Render the marketing address on a single line |
| `system_emails_from_address_id` | integer | No | An Emails::Address id used as the from address for system emails |
| `marketing_emails_from_address_id` | integer | No | An Emails::Address id used as the from address for marketing emails |
| `system_emails_reply_to_address_id` | integer | No | An Emails::Address id used as the reply-to address for system emails |
| `marketing_emails_reply_to_address_id` | integer | No | An Emails::Address id used as the reply-to address for marketing emails |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Template

**Slug:** `CLICKFUNNELS_UPDATE_EMAILS_TEMPLATE`

Update Email Template. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Internal name for the template |
| `subject` | string | No | Default email subject line |
| `html_body` | string | No | HTML email body |
| `text_body` | string | No | Plain text email body |
| `from_address_id` | integer | No | ID of a sending address that belongs to this workspace. A foreign address is rejected with 422. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Topic

**Slug:** `CLICKFUNNELS_UPDATE_EMAILS_TOPIC`

Update Email Topic. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Topic name |
| `description` | string | No | Topic description |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Form

**Slug:** `CLICKFUNNELS_UPDATE_FORMS`

Update Form. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Field

**Slug:** `CLICKFUNNELS_UPDATE_FORMS_FIELDS`

Update Field. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `key` | string | No | Key |
| `label` | string | No | Label |
| `hidden` | boolean | No | Hidden |
| `field_type` | string | No | Field Type |
| `allow_multiple` | boolean | No | Allow Multiple |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Field Set

**Slug:** `CLICKFUNNELS_UPDATE_FORMS_FIELD_SETS`

Update Field Set. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `title` | string | No | Title |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Option

**Slug:** `CLICKFUNNELS_UPDATE_FORMS_FIELDS_OPTIONS`

Update Option. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `label` | string | No | Label |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Submission

**Slug:** `CLICKFUNNELS_UPDATE_FORMS_SUBMISSIONS`

Update Submission. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `contact_id` | integer | No | Contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Answer

**Slug:** `CLICKFUNNELS_UPDATE_FORMS_SUBMISSIONS_ANSWERS`

Update Answer. API access tokens need forms:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `entry` | string | No | Entry |
| `field_id` | string | No | Field |
| `fields_option_id` | integer | No | ID of a record from the Forms::Fields::Option API. |
| `fields_option_ids` | array | No | Fields Options |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Fulfillment

**Slug:** `CLICKFUNNELS_UPDATE_FULFILLMENTS`

Update Fulfillment. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `tracking_url` | string | No | Tracking URL |
| `tracking_code` | string | No | Tracking Code |
| `notify_customer` | boolean | No | Send an email to the customer when the fulfillment is updated. Will use workspace default behavior if left unset |
| `shipping_provider` | string | No | Shipping Provider |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Location

**Slug:** `CLICKFUNNELS_UPDATE_FULFILLMENTS_LOCATIONS`

Update Location. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Location name |
| `address` | object | No | Value for the address request field. |
| `archived` | boolean | No | Indicates if the location is archived |
| `address_name` | string | No | Address name |
| `external_app` | boolean | No | 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. |
| `phone_number` | string | No | Phone number |
| `email_address` | string | No | Email address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Conditional Split Step

**Slug:** `CLICKFUNNELS_UPDATE_FUNNEL_CONDITIONAL_SPLIT_STEP`

Update Conditional Split Step. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `branches` | array | No | Value for the branches request field. |
| `condition` | object | No | Value for the condition request field. |
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Funnel

**Slug:** `CLICKFUNNELS_UPDATE_FUNNELS`

Update Funnel. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name of the Funnel |
| `tag_ids` | array | No | Replace the funnel's tags with numeric IDs from its workspace. An empty array clears tags; null is ignored. |
| `expand__` | array | No | Expand additional data in the response. Use `expand[]=field_name` to include optional fields. Available fields: head_code, footer_code. See the [Expanding guide](https://developers.myclickfunnels.com/docs/expand) for examples. |
| `domain_id` | integer | No | 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. |
| `head_code` | string | No | 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. |
| `live_mode` | boolean | No | 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. |
| `footer_code` | string | No | Custom code to inject before the closing </body> tag. JavaScript should be wrapped in <script> tags. Set to null to clear existing code. |
| `current_path` | string | No | The funnel URL path. It is normalized to lowercase with a leading slash. Blank, root, reserved, and occupied paths are rejected. |
| `head_code_mode` | string ("append" | "replace") | No | How to handle head_code. 'append' adds to existing code (default), 'replace' overwrites. |
| `favicon_image_id` | string | No | 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. |
| `footer_code_mode` | string ("append" | "replace") | No | How to handle footer_code. 'append' adds to existing code (default), 'replace' overwrites. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Split Test Step

**Slug:** `CLICKFUNNELS_UPDATE_FUNNEL_SPLIT_TEST_STEP`

Update Split Test Step. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `variants` | array | Yes | Value for the variants request field. |
| `funnel_id` | string | Yes | Identifier used for the funnel id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tag

**Slug:** `CLICKFUNNELS_UPDATE_FUNNELS_TAGS`

Update Tag. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name of the funnel tag |
| `color` | string | No | The color of the funnel tag |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Image

**Slug:** `CLICKFUNNELS_UPDATE_IMAGES`

Update Image. API access tokens need media:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Image name |
| `alt_text` | string | No | Image alt attribute |
| `upload_source_url` | string | No | The source URL of the image that you want to upload. Not required on Update when not needed to re-upload the image. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order

**Slug:** `CLICKFUNNELS_UPDATE_ORDERS`

Update Order. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `notes` | string | No | Your internal note about the order. This will be visible in ClickFunnels admin orders-related sections. |
| `churned_at` | string | No | (External subscription orders only) Date the subscription churned. |
| `renewal_at` | string | No | 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`. |
| `canceled_at` | string | No | (External subscription orders only) Date the order was canceled. |
| `canceled_by` | string | No | (External subscription orders only) Who canceled the order. |
| `external_id` | string | No | (External orders only) An external ID, e.g., a payment provider's ID or an ID managed by the client internally. |
| `activated_at` | string | No | (External subscription orders only) Date the subscription was activated. |
| `trial_end_at` | string | No | 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. |
| `cancel_reason` | string | No | (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` |
| `billing_status` | string | No | (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`. |
| `next_charge_at` | string | No | (External subscription orders only) Date of the next scheduled charge. |
| `service_status` | string | No | (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`. |
| `cancel_description` | string | No | (External subscription orders only) A free-text description of the cancellation reason. |
| `billing_address_city` | string | No | (External orders only) The city of the billing address. |
| `shipping_address_city` | string | No | (External orders only) The city of the shipping address. |
| `billing_address_region` | string | No | (External orders only) The region of the billing address, like state or province. |
| `billing_address_country` | string | No | (External orders only) The billing address country. |
| `shipping_address_region` | string | No | (External orders only) The region of the shipping address, like state or province. |
| `shipping_address_country` | string | No | (External orders only) The country of the shipping address. |
| `billing_address_street_one` | string | No | (External orders only) The main street information of the billing address, including the street name and number. |
| `billing_address_street_two` | string | No | (External orders only) Additional street information of the billing address, like entrance information and apartment numbers. |
| `shipping_address_last_name` | string | No | (External orders only) The last name of the recipient's shipping address. |
| `billing_address_postal_code` | string | No | (External orders only) Billing address postal (ZIP) code. |
| `shipping_address_first_name` | string | No | (External orders only) The first name of the recipient's shipping address. |
| `shipping_address_street_one` | string | No | (External orders only) The main street information of the shipping address, including the street name and number. |
| `shipping_address_street_two` | string | No | (External orders only) Additional street information for the shipping address, like entrance information and apartment numbers. |
| `shipping_address_postal_code` | string | No | (External orders only) The postal code of the shipping address. |
| `shipping_address_phone_number` | string | No | (External orders only) The phone number of the recipient's shipping address. |
| `shipping_address_organization_name` | string | No | (External orders only) The organization name of the recipient's shipping address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update External Invoice

**Slug:** `CLICKFUNNELS_UPDATE_ORDERS_INVOICES`

Update External Invoice. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `due_at` | string | No | The date the invoice is due. |
| `status` | string ("unpaid" | "paid" | "voided" | "refunded" | "disputed" | "past-due") | No | 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`. |
| `paid_at` | string | No | The date the invoice was paid. Required when changing `status` to `paid`. |
| `issued_at` | string | No | The date the invoice was issued. |
| `external_id` | string | No | The unique identifier for this invoice in your external system. This ID allows you to correlate ClickFunnels invoices with records in your payment processor. |
| `invoice_number` | string | No | A sequential number for bookkeeping purposes. |
| `shipping_amount` | string | No | Invoiced shipping amount. Cannot be negative. |
| `line_items_attributes` | array | No | Update existing line items. Only line items with an `id` will be processed; new line items (without `id`) are ignored during updates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tag

**Slug:** `CLICKFUNNELS_UPDATE_ORDERS_TAGS`

Update Tag. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Tag Name |
| `color` | string | No | Tag Color |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Page

**Slug:** `CLICKFUNNELS_UPDATE_PAGES`

Update Page. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Page name of the editable page element. |
| `expand` | array | No | 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](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. Read a page's existing markup with `expand[]=markup` before editing it: see [Reading Current Markup](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#reading-current-markup) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md). |
| `funnel` | object | No | Optional funnel mutation block. On update, only `show_page_step_id` is supported — swap the page onto an existing show page step. |
| `markup` | string | No | 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](https://accounts.myclickfunnels.com/.well-known/page-markup/skill.md) for the DSL, approval guardrail, and common validation errors. |
| `head_code` | string | No | 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. |
| `seo_index` | boolean | No | 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. |
| `seo_title` | string | No | Custom title for search engine results. Internal pages only — returns 422 on external and custom HTML pages. |
| `custom_css` | string | No | 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. |
| `sort_order` | integer | No | 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. |
| `custom_html` | string | No | 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`. |
| `description` | string | No | A short description of the page (max 1000 characters). |
| `footer_code` | string | No | Custom code to inject before the closing </body> tag. Internal pages only — returns 422 on external pages. Set to null to clear existing code. |
| `current_path` | string | No | 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. |
| `external_url` | string | No | 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](https://accounts.myclickfunnels.com/.well-known/sdk/migrate-external-page-domain/skill.md#4-patch-one-page-at-a-time). |
| `head_code_mode` | string ("append" | "replace") | No | How to handle head_code. 'append' adds to existing code (default), 'replace' overwrites. Internal pages only. |
| `show_page_step` | object | No | 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. |
| `block_ai_search` | boolean | No | 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)](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#crawler-access-ai-opt-out) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md) for coverage limits. |
| `custom_css_mode` | string ("append" | "replace") | No | How to handle custom_css. 'append' adds to existing CSS (default), 'replace' overwrites. Internal pages only. |
| `seo_description` | string | No | Custom meta description for search engine results. Internal pages only — returns 422 on external and custom HTML pages. |
| `block_ai_crawler` | boolean | No | 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)](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#crawler-access-ai-opt-out) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md) for coverage limits. |
| `footer_code_mode` | string ("append" | "replace") | No | How to handle footer_code. 'append' adds to existing code (default), 'replace' overwrites. Internal pages only. |
| `block_ai_assistant` | boolean | No | 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)](https://accounts.myclickfunnels.com/.well-known/pages/skill.md#crawler-access-ai-opt-out) in the [Pages Skill](https://accounts.myclickfunnels.com/.well-known/pages/skill.md) for coverage limits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Product

**Slug:** `CLICKFUNNELS_UPDATE_PRODUCTS`

Update Product. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Product name |
| `tag_ids` | array | No | 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) |
| `image_ids` | array | No | Images |
| `price_ids` | array | No | Price IDs |
| `seo_title` | string | No | A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters. |
| `variant_ids` | array | No | Variant IDs |
| `current_path` | string | No | Current Path |
| `seo_image_id` | string | No | SEO image |
| `commissionable` | boolean | No | Commissionable |
| `seo_description` | string | No | 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). |
| `visible_in_store` | boolean | No | Visible in Store |
| `redirect_funnel_id` | string | No | Redirect funnel |
| `variant_properties` | array | No | The properties of the product's variants. e.g. 'Size', 'Color' etc. |
| `cancellation_funnel_url` | string | No | Cancellation Funnel Url |
| `visible_in_customer_center` | boolean | No | Visible in Customer Center |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Collection

**Slug:** `CLICKFUNNELS_UPDATE_PRODUCTS_COLLECTIONS`

Update Collection. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name of the products collection |
| `image_id` | string | No | Collection image |
| `seo_title` | string | No | Title of the collection for SEO purposes |
| `description` | string | No | Description of the collection |
| `product_ids` | array | No | 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. |
| `sort_method` | string ("manually" | "name_asc" | "name_desc" | "price_desc" | "price_asc" | "added_at_desc" | "added_at_asc" | "created_at_desc" | "created_at_asc") | No | Method used to sort the products in the collection |
| `collection_type` | string | No | Type of the collection (manual or automatic) |
| `seo_description` | string | No | Description of the collection for SEO purposes |
| `social_image_id` | string | No | Image for social sharing |
| `visible_in_store` | boolean | No | Whether the collection is visible in the online store |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Price

**Slug:** `CLICKFUNNELS_UPDATE_PRODUCTS_PRICES`

Update Price. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `key` | string | No | Key |
| `cost` | string | No | Cost |
| `name` | string | No | Name |
| `amount` | string | No | Amount |
| `visible` | boolean | No | Visible |
| `archived` | boolean | No | Archived |
| `currency` | string | No | Currency. Ignored on write — a price always takes its workspace's currency, so sending a different one has no effect. |
| `duration` | integer | No | Amount of payments. Only used by a payment_plan price. |
| `interval` | string ("days" | "weeks" | "months" | "quarters" | "years") | No | Billing period unit — note the values are plural ('months', not 'month'). Only used by a subscription or payment_plan price. |
| `self_cancel` | boolean | No | Customer can cancel |
| `payment_type` | string ("one_time" | "subscription" | "payment_plan") | No | Defaults to 'one_time' if left blank |
| `self_upgrade` | boolean | No | 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. |
| `setup_amount` | string | No | Setup amount |
| `trial_amount` | string | No | 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. |
| `interval_count` | integer | No | How many intervals between charges — interval 'months' with interval_count 3 bills every 3 months. Only used by a subscription or payment_plan price. |
| `self_downgrade` | boolean | No | 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. |
| `trial_duration` | integer | No | 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. |
| `trial_interval` | string ("days" | "weeks" | "months" | "quarters" | "years") | No | 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. |
| `self_reactivate` | boolean | No | Customer can reactivate |
| `compare_at_amount` | string | No | Compare at amount |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tag

**Slug:** `CLICKFUNNELS_UPDATE_PRODUCTS_TAGS`

Update Tag. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name of the product tag |
| `color` | string | No | The color of the product tag |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Variant

**Slug:** `CLICKFUNNELS_UPDATE_PRODUCTS_VARIANTS`

Update Variant. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `sku` | string | No | SKU |
| `name` | string | No | Variant name |
| `width` | number | No | Width |
| `height` | number | No | Height |
| `length` | number | No | Length |
| `weight` | number | No | Weight |
| `taxable` | string | No | Taxable |
| `visible` | boolean | No | Is visible |
| `archived` | boolean | No | Archived |
| `asset_ids` | array | No | 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. |
| `image_ids` | array | No | The images for the variant. |
| `description` | string | No | The description of the variant. The description of the **default variant** is the user-facing description of the `Product`. |
| `weight_unit` | string | No | Weight unit |
| `product_type` | string | No | Product type |
| `track_quantity` | boolean | No | Track Quantity |
| `dimensions_unit` | string | No | Dimensions unit |
| `tax_category_id` | string | No | Tax category ID |
| `properties_values` | array | No | The property values of the Variant. e.g. 'Large', 'Red' etc. |
| `out_of_stock_sales` | boolean | No | Out of stock sales |
| `fulfillment_required` | boolean | No | Fulfillment required |
| `country_of_manufacture_id` | string | No | Country of manufacture |
| `fulfillments_location_ids` | array | No | The fulfillment locations for the variant. |
| `included_courses_attributes` | array | No | 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. |
| `has_access_to_all_valid_assets` | boolean | No | 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. |
| `included_space_groups_attributes` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Refine Filter

**Slug:** `CLICKFUNNELS_UPDATE_REFINE_FILTER`

Update Refine Filter. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Public id of the RefineFilter to update. |
| `results` | string | No | Return projected matches inline. Pass `true` for ids only; omit for the filter definition alone. |
| `refine_filter` | object | Yes | Value for the refine filter request field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Opportunity

**Slug:** `CLICKFUNNELS_UPDATE_SALES_OPPORTUNITIES`

Update Opportunity. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name |
| `value` | number | No | The potential value of this opportunity in the default currency of the workspace |
| `closed_at` | string | No | Close date |
| `assignee_id` | integer | No | 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`. |
| `pipelines_stage_id` | integer | No | Pipeline Stage ID |
| `primary_contact_id` | integer | No | Primary Contact ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Note

**Slug:** `CLICKFUNNELS_UPDATE_SALES_OPPORTUNITIES_NOTES`

Update Note. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `content` | string | No | Content |
| `created_by_id` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Pipeline

**Slug:** `CLICKFUNNELS_UPDATE_SALES_PIPELINES`

Update Pipeline. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Pipeline name |
| `stages_attributes` | array | No | The stages of the pipeline. The stages are ordered by the position attribute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Stage

**Slug:** `CLICKFUNNELS_UPDATE_SALES_PIPELINES_STAGES`

Update Stage. API access tokens need opportunities:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Stage name |
| `sort_order` | integer | No | 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. |
| `close_probability` | number | No | Close probability of the opportunities in this stage |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Segment

**Slug:** `CLICKFUNNELS_UPDATE_SEGMENTS`

Update Segment. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `results` | string | No | Return matching contacts inline; omit for the audience definition alone. Requires contacts:read. Count is opt-in. |
| `segment` | object | Yes | Value for the segment request field. |
| `body_results` | string | No | Return projected matches inline. Pass `true` for ids only; omit for the filter definition alone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update shipping addresses

**Slug:** `CLICKFUNNELS_UPDATE_SHIPPING_ADDRESSES`

Update shipping addresses. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `address` | object | No | 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. |
| `default` | boolean | No | Set true to select this entry. False on the current default returns 422; select another entry instead. |
| `last_name` | string | No | Last name |
| `first_name` | string | No | First name |
| `phone_number` | string | No | Phone number |
| `organization_name` | string | No | Organization name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Package

**Slug:** `CLICKFUNNELS_UPDATE_SHIPPING_PACKAGES`

Update Package. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name |
| `width` | number | No | Width |
| `height` | number | No | Height |
| `length` | number | No | Length |
| `weight` | number | No | Weight |
| `carrier` | string ("fedex" | "ups" | "usps") | No | Carrier |
| `weight_unit` | string ("lb" | "kg" | "g" | "oz") | No | Weight Unit |
| `empty_weight` | string | No | Empty Weight |
| `package_type` | string ("box" | "envelope" | "soft_package") | No | Package Type |
| `distance_unit` | string | No | Distance Unit |
| `default_package` | boolean | No | Default Package |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Profile

**Slug:** `CLICKFUNNELS_UPDATE_SHIPPING_PROFILES`

Update Profile. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name |
| `variant_ids` | array | No | Variant IDs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Rate

**Slug:** `CLICKFUNNELS_UPDATE_SHIPPING_RATES`

Update Rate. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `price` | string | No | Price |
| `provider_name` | string | No | Provider Name |
| `rates_name_id` | integer | No | Rate name ID |
| `price_currency` | string | No | Price Currency |
| `live_rates_provider` | string | No | Live Rates Provider |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Name

**Slug:** `CLICKFUNNELS_UPDATE_SHIPPING_RATES_NAMES`

Update Name. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Rate Name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Zone

**Slug:** `CLICKFUNNELS_UPDATE_SHIPPING_ZONES`

Update Zone. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name |
| `region_ids` | array | No | Region IDs |
| `country_ids` | array | No | Country IDs |
| `address_filter_id` | string | No | Zone |
| `includes_rest_of_world` | boolean | No | Includes Rest of the World |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Site

**Slug:** `CLICKFUNNELS_UPDATE_SITE`

Update Site. API access tokens need sites:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the site. |
| `expand__` | array | No | 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](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |
| `head_code` | string | No | 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. |
| `footer_code` | string | No | Custom code to inject before the closing </body> tag. JavaScript should be wrapped in <script> tags. Set to null to clear existing code. |
| `homepage_id` | string | No | 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. |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `head_code_mode` | string ("append" | "replace") | No | How to handle head_code. 'append' adds to existing code (default), 'replace' overwrites. |
| `footer_code_mode` | string ("append" | "replace") | No | How to handle footer_code. 'append' adds to existing code (default), 'replace' overwrites. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Store

**Slug:** `CLICKFUNNELS_UPDATE_STORES`

Update Store. API access tokens need store:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Name |
| `status` | string ("draft" | "published") | No | Store Status |
| `seo_title` | string | No | SEO title |
| `current_path` | string | No | Current path |
| `seo_indexable` | boolean | No | SEO Indexable |
| `seo_description` | string | No | SEO description |
| `social_image_id` | string | No | Social image |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Team

**Slug:** `CLICKFUNNELS_UPDATE_TEAM`

Update Team. API access tokens need account:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | The name of your Team |
| `locale` | string ("en" | "ja" | "pt") | No | The main language used to create a new website. |
| `time_zone` | string | No | 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.](https://dash.readme.com/project/cf2/v2/docs/timezones). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Theme

**Slug:** `CLICKFUNNELS_UPDATE_THEMES`

Update Theme. API access tokens need sites:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `custom_name` | string | No | A custom name to override the theme name |
| `template_pages` | object | No | 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. |
| `current_style_id` | integer | No | The style that will be applied to the theme |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Short Link

**Slug:** `CLICKFUNNELS_UPDATE_URL_REDIRECTS`

Update Short Link. API access tokens need funnels:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Short link name. |
| `utm_term` | string | No | UTM term. |
| `domain_id` | string | No | Ready-for-use domain in this workspace (numeric or public ID). Null or 0 selects the default-site domain. |
| `pixel_code` | string | No | Pixel markup; omitted on create or explicit null becomes an empty string. |
| `second_url` | string | No | Optional split destination. |
| `utm_medium` | string | No | UTM medium. |
| `utm_source` | string | No | UTM source. |
| `utm_content` | string | No | UTM content. |
| `current_path` | string | No | Explicit nonblank paths are normalized and require exact ownership: another resource's current URL, historical alias or occupied custom-domain root cannot be taken. Omitted/blank on create and blank on update generate a path; omitted on update preserves it. |
| `original_url` | string | No | Required destination on create. |
| `utm_campaign` | string | No | UTM campaign. |
| `redirect_type` | string ("temporary" | "permanent") | No | Value for the redirect type request field. |
| `split_percentage` | integer | No | Value for the split percentage request field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Incoming External Purchase Endpoint

**Slug:** `CLICKFUNNELS_UPDATE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_ENDPOINTS`

Update Incoming External Purchase Endpoint. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Human-readable endpoint name. |
| `secret` | string | No | 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. |
| `suppress_order_system_emails` | boolean | No | Whether ClickFunnels suppresses its order system emails for purchases received by this endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Incoming External Purchase Product Mapping

**Slug:** `CLICKFUNNELS_UPDATE_WEBHOOKS_INCOMING_EXTERNAL_PURCHASE_PRODUCT_MAPPINGS`

Update Incoming External Purchase Product Mapping. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `products_price_id` | string | No | Integer database id or obfuscated public_id. |
| `products_variant_id` | string | No | Integer database id or obfuscated public_id. |
| `external_product_sku` | string | No | Provider product, plan, or SKU identifier. For Whop, use the plan ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Endpoint

**Slug:** `CLICKFUNNELS_UPDATE_WEBHOOKS_OUTGOING_ENDPOINTS`

Update Endpoint. API access tokens need webhooks:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `url` | string | No | The URL that ClickFunnels event webhooks will be sent to. |
| `name` | string | No | The custom name for the webhook endpoint. |
| `page_ids` | array | No | 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. |
| `funnel_ids` | array | No | 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. |
| `event_type_ids` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workflow

**Slug:** `CLICKFUNNELS_UPDATE_WORKFLOW`

Update Workflow. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | New name for the workflow. |
| `archived` | boolean | No | Set to `true` to archive the workflow, `false` to unarchive. |
| `run_type` | string ("asynchronous" | "synchronous" | "one_time") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Step

**Slug:** `CLICKFUNNELS_UPDATE_WORKFLOW_STEP`

Update Step. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Value for the name request field. |
| `branch` | string | No | Value for the branch request field. |
| `position` | integer | No | Value for the position request field. |
| `after_step_id` | string | No | Integer database id or obfuscated public_id. |
| `parent_step_id` | string | No | Integer database id or obfuscated public_id. |
| `step_type_settings` | object | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Trigger

**Slug:** `CLICKFUNNELS_UPDATE_WORKFLOW_TRIGGER`

Update Trigger. API access tokens need workflows:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `active` | boolean | No | Value for the active request field. |
| `page_id` | string | No | Integer database id or obfuscated public_id. |
| `course_id` | string | No | Integer database id or obfuscated public_id. |
| `funnel_id` | string | No | Integer database id or obfuscated public_id. |
| `product_id` | string | No | Integer database id or obfuscated public_id. |
| `community_id` | string | No | Integer database id or obfuscated public_id. |
| `event_type_key` | 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") | No | New event key. Must be one of the enumerated keys; an invalid key returns 422. |
| `contacts_tag_id` | string | No | Integer database id or obfuscated public_id. |
| `calendar_event_id` | string | No | Integer database id or obfuscated public_id. |
| `courses_lesson_id` | string | No | Integer database id or obfuscated public_id. |
| `workflows_step_id` | string | No | Integer database id or obfuscated public_id. |
| `courses_section_id` | string | No | Integer database id or obfuscated public_id. |
| `product_variant_id` | string | No | Integer database id or obfuscated public_id. |
| `sales_pipelines_id` | string | No | Integer database id or obfuscated public_id. |
| `survey_workflow_id` | string | No | Integer database id or obfuscated public_id. |
| `communities_space_id` | string | No | Integer database id or obfuscated public_id. |
| `emails_broadcasts_id` | string | No | Integer database id or obfuscated public_id. |
| `cancellation_product_id` | string | No | Integer database id or obfuscated public_id. |
| `allow_anonymous_contacts` | boolean | No | Value for the allow anonymous contacts request field. |
| `appointments_calendar_id` | string | No | Integer database id or obfuscated public_id. |
| `appointments_event_type_id` | string | No | Integer database id or obfuscated public_id. |
| `communities_space_group_id` | string | No | Integer database id or obfuscated public_id. |
| `subscription_variant_to_id` | string | No | Integer database id or obfuscated public_id. |
| `cancellation_product_variant_id` | string | No | Integer database id or obfuscated public_id. |
| `subscription_cancelation_reason` | string | No | Value for the subscription cancelation reason request field. |
| `current_sales_pipelines_stage_id` | string | No | Integer database id or obfuscated public_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workspace

**Slug:** `CLICKFUNNELS_UPDATE_WORKSPACES`

Update Workspace. API access tokens need account:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |
| `name` | string | No | Workspace Name |
| `subdomain` | string | No | The subdomain can currently only be changed in rare cases right after the creation of your new workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert a Contact

**Slug:** `CLICKFUNNELS_UPSERT_CONTACTS`

Upsert a Contact. API access tokens need contacts:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fb_url` | string | No | Facebook URL |
| `tag_ids` | array | No | 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). |
| `expand__` | array | No | Expand additional data in the response. Use `expand[]=field_name` to include optional fields (e.g., `expand[]=email_engagement`). See the [Expanding guide](https://developers.myclickfunnels.com/docs/expand) for available fields and examples. |
| `last_name` | string | No | Last name |
| `time_zone` | string | No | 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.](https://dash.readme.com/project/cf2/v2/docs/timezones). |
| `first_name` | string | No | First name |
| `twitter_url` | string | No | Twitter URL |
| `website_url` | string | No | Website URL |
| `linkedin_url` | string | No | LinkedIn URL |
| `phone_number` | string | No | Phone number |
| `workspace_id` | string | Yes | Identifier used for the workspace id path segment. |
| `email_address` | string | No | Email address |
| `instagram_url` | string | No | Instagram URL |
| `custom_attributes` | object | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Email Domain

**Slug:** `CLICKFUNNELS_VERIFY_EMAILS_DOMAINS`

Verify Email Domain. API access tokens need emails:write permission; the coarse write permission also authorizes this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier used for the id path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |