### Create Product Variant Request Example Source: https://developers.myclickfunnels.com/reference/createproductsvariants Example JSON structure for the request body when creating a new product variant. ```json "length": "66.0", "dimensions_unit": "inches", "tax_category_id": null, "taxable": null, "track_quantity": false, "archived": false, "visible": true, "fulfillment_required": false, "country_of_manufacture_id": null, "image_ids": [], "fulfillments_location_ids": [] } } } } ``` -------------------------------- ### Update Price Success Response Example Source: https://developers.myclickfunnels.com/reference/updateproductsprices Example JSON response returned upon a successful price update. ```json { "id": 78, "public_id": "lbeLiS", "variant_id": 79, "name": "Example Price", "amount": "100.00", "cost": "0.00", "currency": "USD", "duration": null, "interval": null, "trial_interval": null, "trial_duration": null, "trial_amount": "0.00", "setup_amount": null, "self_cancel": true, "self_upgrade": true, "self_downgrade": true, "self_reactivate": true, "interval_count": null, "payment_type": "one_time", "visible": true, "compare_at_amount": null, "key": null, "archived": false, "created_at": "2025-01-01T00:00:00.000Z", "updated_at": "2025-01-01T00:00:00.000Z" } ``` -------------------------------- ### Sales Opportunities Note Parameters Example Source: https://developers.myclickfunnels.com/reference/createsalesopportunitiesnotes This example shows the parameters required to create a new Sales Opportunities Note. It includes the note's content and an optional creator ID. ```json { "sales_opportunities_note": { "content": "Example note", "created_by_id": 42 } } ``` -------------------------------- ### List Shipping Zones Response Example Source: https://developers.myclickfunnels.com/reference/listshippingzones Example JSON response returned when successfully listing shipping zones for a location group. ```json [ { "id": 12, "public_id": "JEXAoc", "location_group_id": 22, "name": "Example Shipping Zone", "address_filter_id": null, "region_ids": [], "country_ids": [], "includes_rest_of_world": false, "created_at": "2025-01-01T00:00:00.000Z", "updated_at": null }, { "id": 13, "public_id": "Wrbnmx", "location_group_id": 23, "name": "Example Shipping Zone", "address_filter_id": null, "region_ids": [ 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 4851 ], "country_ids": [], "includes_rest_of_world": false, "created_at": "2025-01-01T00:00:00.000Z", "updated_at": null } ] ``` -------------------------------- ### Link Header for Next Page Example Source: https://developers.myclickfunnels.com/docs/pagination An example of the 'Link' header, which directly provides a URL to the next page of results, simplifying the pagination process. ```http # Example header. Link: ; rel="next" ``` -------------------------------- ### Not Found Error Response Example Source: https://developers.myclickfunnels.com/reference/updateproductsprices Example JSON response when the requested record is not found. ```json { "error": "Not found: Record missing" } ``` -------------------------------- ### Update Price Request Body Example Source: https://developers.myclickfunnels.com/reference/updateproductsprices Example JSON payload for updating a product price. ```json "duration": 1, "interval": "months", "trial_interval": "days", "trial_duration": 14, "trial_amount": "0.00", "setup_amount": null, "self_cancel": true, "self_upgrade": true, "self_downgrade": true, "self_reactivate": true, "interval_count": 1, "payment_type": "one_time", "visible": true, "compare_at_amount": null, "key": null, "archived": false } } } ``` -------------------------------- ### Apply Page Markup Example Source: https://developers.myclickfunnels.com/reference/createpagemarkup This example demonstrates how to apply PML markup to a specific page using the ClickFunnels API. Ensure the `page_markup` object contains a valid `markup` string. ```json { "page_markup": { "markup": "section { row { column { headline { \"Welcome to our page\" } sub_headline { \"Start your journey here\" } } } } " } } ``` -------------------------------- ### GET /products Source: https://developers.myclickfunnels.com/reference/listproducts Retrieves a list of products associated with the workspace. ```APIDOC ## GET /products ### Description Retrieves a list of products available in the account. ### Method GET ### Endpoint /products ### Response #### Success Response (200) - **id** (integer) - Product ID - **public_id** (string) - Public identifier - **workspace_id** (integer) - Workspace ID - **name** (string) - Product name - **archived** (boolean) - Archive status - **visible_in_store** (boolean) - Store visibility - **visible_in_customer_center** (boolean) - Customer center visibility - **seo_title** (string) - SEO title - **seo_description** (string) - SEO description - **commissionable** (boolean) - Commission status - **variant_properties** (array) - List of variant properties #### Response Example { "id": 127, "public_id": "eBENtI", "workspace_id": 42000, "name": "Sample Product", "archived": false, "visible_in_store": true, "visible_in_customer_center": true, "seo_title": "Buy Sample Product Online", "seo_description": "This is a sample product.", "commissionable": true, "variant_properties": [ { "id": 127, "name": "Color" } ] } ### Error Handling - **401 Unauthorized**: API key missing or invalid. - **404 Not Found**: The requested record does not exist. ``` -------------------------------- ### Pagination-Next Header Example Source: https://developers.myclickfunnels.com/docs/pagination An example of the 'Pagination-Next' header, which can provide the ID of the last item in the current list response, useful for constructing the next request. ```http # Example header. Pagination-Next: 55 ``` -------------------------------- ### GET /websites/developers_myclickfunnels/tags Source: https://developers.myclickfunnels.com/reference/getproductstags Retrieves a tag for a product. ```APIDOC ## GET /websites/developers_myclickfunnels/tags ### Description Retrieve a tag for a product. ### Method GET ### Endpoint /websites/developers_myclickfunnels/tags ``` -------------------------------- ### Full Authorization URL Example Source: https://developers.myclickfunnels.com/docs/oauth-20 Construct the complete authorization URL by including your application's client ID, the grant type, your redirect URI, and the response type. The `new_installation` parameter must be set to `true`. URI-encoding the `redirect_uri` is recommended to prevent errors. ```http https://accounts.myclickfunnels.com/oauth/authorize?client_id=7qRRTSF020jfLFKSJjksdfKJSDF&grant_type=authorization_code&redirect_uri=https://your-server.com/clickfunnels/oauth_callback&response_type=code&new_installation=true ``` -------------------------------- ### Sorting Query Parameter: sort_order Source: https://developers.myclickfunnels.com/reference/listemailstopics Specifies the sort order for list responses. Use 'desc' to reverse the default 'asc' (ascending) order. Refer to the ClickFunnels API guides for examples. ```json { "name": "sort_order", "in": "query", "description": "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).", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ``` -------------------------------- ### GET /orders/invoices/{id} Source: https://developers.myclickfunnels.com/reference/getordersinvoices Retrieve a specific invoice using its unique identifier. This endpoint is useful for fetching detailed information about a particular order invoice, including product details, pricing, and fulfillment status. Refer to the [Orders Overview guide](https://developers.myclickfunnels.com/docs/orders/invoices) for more context on invoices and payment processors. ```APIDOC ## GET /orders/invoices/{id} ### Description Retrieve a specific invoice using its unique identifier. This endpoint is useful for fetching detailed information about a particular order invoice, including product details, pricing, and fulfillment status. Refer to the [Orders Overview guide](https://developers.myclickfunnels.com/docs/orders/invoices) for more context on invoices and payment processors. ### Method GET ### Endpoint /orders/invoices/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the invoice to retrieve. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **id** (integer) - The unique identifier of the invoice. - **public_id** (string) - The public-facing identifier for the invoice. - **invoice_id** (integer) - The internal invoice ID. - **external_id** (string|null) - External system's ID for the invoice. - **payment_type** (string|null) - The type of payment used. - **description** (string|null) - A description of the invoice. - **quantity** (integer) - The total quantity of items in the invoice. - **fulfillment_status** (string) - The current fulfillment status of the invoice (e.g., "unfulfilled"). - **external_product_id** (string|null) - External product identifier. - **discount_amount** (string) - The amount of discount applied. - **state_tax_amount** (string) - The amount of state tax. - **county_tax_amount** (string) - The amount of county tax. - **city_tax_amount** (string) - The amount of city tax. - **district_tax_amount** (string) - The amount of district tax. - **state_tax_rate** (string) - The state tax rate. - **county_tax_rate** (string) - The county tax rate. - **city_tax_rate** (string) - The city tax rate. - **district_tax_rate** (string) - The district tax rate. - **country_tax_jurisdiction** (string|null) - The country tax jurisdiction. - **state_tax_jurisdiction** (string|null) - The state tax jurisdiction. - **county_tax_jurisdiction** (string|null) - The county tax jurisdiction. - **city_tax_jurisdiction** (string|null) - The city tax jurisdiction. - **period_start_at** (string|null) - The start date of the billing period. - **period_end_at** (string|null) - The end date of the billing period. - **period_number** (integer|null) - The billing period number. - **created_at** (string) - The timestamp when the invoice was created. - **updated_at** (string) - The timestamp when the invoice was last updated. - **amount** (string) - The total amount of the invoice. - **products_price** (object) - Pricing details for the products. - **id** (integer) - Product price ID. - **public_id** (string) - Public ID for the product price. - **amount** (string) - The price amount. - **currency** (string) - The currency of the price. - **duration** (string|null) - The duration of the product price (e.g., "monthly"). - **interval** (string|null) - The interval for recurring pricing. - **interval_count** (integer|null) - The count for the pricing interval. - **products_variant** (object) - Details of the product variant. - **id** (integer) - The product variant ID. - **public_id** (string) - The public ID of the product variant. - **product_id** (integer) - The ID of the associated product. - **name** (string) - The name of the product variant. - **description** (string|null) - The description of the product variant. - **sku** (string|null) - The Stock Keeping Unit (SKU) for the variant. - **fulfillment_required** (boolean|null) - Indicates if fulfillment is required for this variant. #### Response Example ```json { "id": 682, "public_id": "RegpVj", "invoice_id": 838, "external_id": null, "payment_type": null, "description": null, "quantity": 1, "fulfillment_status": "unfulfilled", "external_product_id": null, "discount_amount": "0.0", "state_tax_amount": "0.0", "county_tax_amount": "0.0", "city_tax_amount": "0.0", "district_tax_amount": "0.0", "state_tax_rate": "0.0", "county_tax_rate": "0.0", "city_tax_rate": "0.0", "district_tax_rate": "0.0", "country_tax_jurisdiction": null, "state_tax_jurisdiction": null, "county_tax_jurisdiction": null, "city_tax_jurisdiction": null, "period_start_at": null, "period_end_at": null, "period_number": null, "created_at": "2026-01-10T20:16:16.538Z", "updated_at": "2026-01-10T20:16:16.538Z", "amount": "3.00", "products_price": { "id": 22229, "public_id": "YqEWxY", "amount": "198.00", "currency": "usd", "duration": null, "interval": null, "interval_count": null }, "products_variant": { "id": 22228, "public_id": "JdknyN", "product_id": 6512, "name": "Seinfeld In Your Pocket - Comedy Joke Machine (Black Premium)", "description": null, "sku": "SIYP-BLACK-PREMIUM-001", "fulfillment_required": false } } ``` #### Error Response (401) - **error** (string) - Description of the error, e.g., "API key missing or invalid". #### Error Response Example (401) ```json { "error": "API key missing or invalid" } ``` #### Error Response (404) - **error** (string) - Description of the error, e.g., "Not found: Record missing". #### Error Response Example (404) ```json { "error": "Not found: Record missing" } ``` ``` -------------------------------- ### Create Product Variant Success Response Source: https://developers.myclickfunnels.com/reference/createproductsvariants Example JSON response returned upon successfully creating a product variant. ```json { "id": 83, "public_id": "wbMmJc", "product_id": 138, "name": "Sleek Copper Coat variant da19", "description": "Qui maiores voluptas rerum.", "sku": "3XCTSoc6kjVOUj1c", "product_type": "physical", "properties_value_ids": [ null ], "out_of_stock_sales": null, "weight": "43.0", "weight_unit": "lb", "height": "34.0", "width": "543.0", "length": "93.0", "dimensions_unit": "inches", "quantity": 0, "tag_ids": [ 222 ], "tax_category_id": null, "asset_ids": [], "taxable": null, "track_quantity": false, "archived": false, "visible": true, "price_ids": [], "fulfillment_required": false, "country_of_manufacture_id": null, "image_ids": [], "fulfillments_location_ids": [], "created_at": "2025-08-11T19:15:04.428Z", "updated_at": "2025-08-11T19:15:04.428Z", "default": false, "properties_values": [ { "property_id": 83, "value": "Red" } ], "created_by_platform_application": null } ``` -------------------------------- ### POST /websites/developers_myclickfunnels/products Source: https://developers.myclickfunnels.com/reference/createproducts Creates a new product. Requires product name and allows for various optional fields like visibility, SEO details, and variant properties. ```APIDOC ## POST /websites/developers_myclickfunnels/products ### Description Creates a new product with the provided details. The `name` field is required. ### Method POST ### Endpoint /websites/developers_myclickfunnels/products ### Parameters #### Request Body - **name** (string) - Required - Product name - **current_path** (string | null) - Optional - Current Path - **visible_in_store** (boolean | null) - Optional - Visible in Store - **visible_in_customer_center** (boolean | null) - Optional - Visible in Customer Center - **seo_title** (string | null) - Optional - A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters. - **seo_description** (string | null) - Optional - SEO Description - **commissionable** (boolean | null) - Optional - Commissionable - **image_ids** (array | null) - Optional - Images - **default_variant_id** (integer | null) - Optional - The ID of the default variant of the product - **variant_ids** (array | null) - Optional - Variant IDs - **price_ids** (array | null) - Optional - Price IDs - **tag_ids** (array | null) - Optional - Any valid array, empty or with valid tags 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) - **redirect_funnel_id** (string | null) - Optional - Redirect funnel - **cancellation_funnel_url** (string | null) - Optional - Cancellation Funnel Url - **variant_properties** (array | null) - Optional - Properties that are specific to the default variant of a product - **id** (integer) - Required - ID - **name** (string) - Required - Name ### Request Example ```json { "name": "Sample Product", "visible_in_store": true, "seo_title": "Buy Sample Product Online", "seo_description": "This is a sample product.", "commissionable": true, "image_ids": [], "default_variant_id": 22, "variant_ids": [22], "price_ids": [], "tag_ids": [], "redirect_funnel_id": null, "cancellation_funnel_url": null, "variant_properties": [ { "id": 22, "name": "Color" } ] } ``` ### Response #### Success Response (200) - **id** (integer) - Description - **public_id** (string) - Description - **workspace_id** (integer) - Description - **name** (string) - Description - **current_path** (string | null) - Description - **archived** (boolean) - Description - **visible_in_store** (boolean) - Description - **visible_in_customer_center** (boolean) - Description - **image_id** (integer | null) - Description - **seo_title** (string) - Description - **seo_description** (string) - Description - **seo_image_id** (integer | null) - Description - **commissionable** (boolean) - Description - **image_ids** (array) - Description - **default_variant_id** (integer) - Description - **variant_ids** (array) - Description - **price_ids** (array) - Description - **tag_ids** (array) - Description - **redirect_funnel_id** (string | null) - Description - **cancellation_funnel_url** (string | null) - Description - **created_at** (string) - Added - **updated_at** (string) - Updated - **variant_properties** (array) - Properties that are specific to the default variant of a product - **id** (integer) - ID - **name** (string) - Name #### Response Example ```json { "id": 22, "public_id": "RTWMAd", "workspace_id": 42000, "name": "Sample Product", "current_path": null, "archived": false, "visible_in_store": true, "visible_in_customer_center": true, "image_id": null, "seo_title": "Buy Sample Product Online", "seo_description": "This is a sample product.", "seo_image_id": null, "commissionable": true, "image_ids": [], "default_variant_id": 22, "variant_ids": [ 22 ], "price_ids": [], "tag_ids": [], "redirect_funnel_id": null, "cancellation_funnel_url": null, "created_at": "2025-01-01T00:00:00.000Z", "updated_at": "2025-01-01T00:00:00.000Z", "variant_properties": [ { "id": 22, "name": "Color" } ] } ``` ``` -------------------------------- ### Contact Object Schema Example Source: https://developers.myclickfunnels.com/reference/upsertcontacts Example structure of a contact object used for creation or updates. ```json { "contact": { "email_address": "test-4059727ec8e173ce4648@example.com", "first_name": "Sol", "last_name": "Jones", "phone_number": "(224) 508-1342 x59891", "time_zone": "Pacific Time (US & Canada)", "fb_url": "https://www.facebook.com/example", "twitter_url": "https://twitter.com/example", "instagram_url": null, "linkedin_url": "https://www.linkedin.com/in/example", "website_url": "https://example.com" } } ``` -------------------------------- ### Combining expansion with other query parameters Source: https://developers.myclickfunnels.com/docs/expand Example of using expansion alongside filtering, sorting, and pagination parameters. ```shell curl 'https://myworkspace.myclickfunnels.com/api/v2/workspaces/100/contacts?filter[email_address]=jane@example.com&expand[]=email_engagement&sort_order=asc&after=24350' \ -H 'Authorization: Bearer {token}' ``` -------------------------------- ### POST /websites/developers_myclickfunnels/stores Source: https://developers.myclickfunnels.com/reference/createstores Creates a new store within the specified workspace. ```APIDOC ## POST /websites/developers_myclickfunnels/stores ### Description Creates a new store within the specified workspace. ### Method POST ### Endpoint https://{subdomain}.myclickfunnels.com/api/v2/stores ### Request Body - **name** (string) - Required - The name of the store. - **current_path** (string|null) - Optional - The current path for the store. - **seo_title** (string|null) - Optional - The SEO title for the store. - **seo_description** (string|null) - Optional - The SEO description for the store. - **seo_indexable** (boolean|null) - Optional - Whether the store should be indexable by search engines. - **social_image_id** (string|null) - Optional - The ID of the social image to associate with the store. ### Request Example { "name": "New Store", "current_path": "/new-store", "seo_title": "New Store Title", "seo_description": "Description for the new store.", "seo_indexable": true, "social_image_id": "img_abc123" } ### Response #### Success Response (201) - **data** (object) - The newly created store object, with the same structure as returned by the GET /stores endpoint. #### Response Example { "data": { "id": 2, "public_id": "newIdXYZ", "name": "New Store", "current_path": "/new-store", "seo_title": "New Store Title", "seo_description": "Description for the new store.", "seo_indexable": true, "social_image_id": "img_abc123", "status": "draft", "created_at": "2023-10-27T10:00:00Z", "updated_at": "2023-10-27T10:00:00Z", "workspace_id": 42000 } } ``` -------------------------------- ### Update Page Request Example Source: https://developers.myclickfunnels.com/reference/updatepages Example JSON payload for updating a page's metadata and injecting custom head code. ```json { "page": { "name": "Example Page", "description": "Updated page description", "seo_title": "Updated SEO Title", "seo_description": "Updated meta description", "seo_index": true, "head_code": "", "head_code_mode": "append" } } ``` -------------------------------- ### Create Email Broadcast Example Payload Source: https://developers.myclickfunnels.com/reference/createemailsbroadcast Example JSON structure for creating a scheduled email broadcast with recipient details and topic associations. ```json { "emails_broadcast": { "name": "Weekly Newsletter", "subject": "This Week's Updates", "preheadline": "Check out what's new", "from_email": "marketing@example.com", "reply_to_email": "replies@example.com", "html_body": "

Hello World

", "text_body": "Hello World", "send_immediately": false, "send_at": "2025-06-01", "send_at_local_time": "18:00:00", "time_zone": "Pacific Time (US & Canada)", "topic_ids": [ 1, 2 ], "recipients": [ { "email": "user@example.com", "first_name": "Jane", "last_name": "Doe" } ] } } ``` -------------------------------- ### Fetch Package Source: https://developers.myclickfunnels.com/reference/getshippingpackages Retrieve a package for a workspace. ```APIDOC ## GET /websites/developers_myclickfunnels/packages ### Description Retrieve a package for a workspace. ### Method GET ### Endpoint /websites/developers_myclickfunnels/packages ### Query Parameters - **workspace_id** (string) - Required - The ID of the workspace to fetch the package for. ``` -------------------------------- ### Bad Request Error Example Source: https://developers.myclickfunnels.com/reference/createpagemarkup This example shows the response format for a bad request, specifically when the required `markup` field is missing from the `page_markup` object. ```json { "error": "Bad request: page_markup[markup] is required" } ``` -------------------------------- ### POST /websites/developers_myclickfunnels/products_collections Source: https://developers.myclickfunnels.com/reference/createproductscollections Creates a new products collection with the provided details. ```APIDOC ## POST /websites/developers_myclickfunnels/products_collections ### Description Creates a new products collection. ### Method POST ### Endpoint /websites/developers_myclickfunnels/products_collections ### Request Body - **products_collection** (object) - Required - The details of the products collection to create. ### Request Example ```json { "products_collection": { "name": "Example Collection", "description": "Example Description", "collection_type": "manual", "product_ids": [], "sort_method": "manually", "visible_in_store": true, "seo_title": "Example SEO Title", "seo_description": "Example SEO Description" } } ``` ### Response #### Success Response (201) - **id** (integer) - The unique identifier for the created products collection. - **public_id** (string) - The public identifier for the created products collection. - **workspace_id** (integer) - The workspace ID associated with the collection. - **name** (string) - The name of the products collection. - **description** (string) - The description of the products collection. - **collection_type** (string) - The type of collection (e.g., "manual"). - **product_ids** (array) - A list of product IDs included in the collection. - **sort_method** (string) - The method used for sorting products within the collection. - **archived** (boolean) - Indicates if the collection is archived. - **image_id** (integer or null) - The ID of the associated image, if any. - **visible_in_store** (boolean) - Indicates if the collection is visible in the store. - **current_path** (string or null) - The current path of the collection. - **seo_title** (string) - The SEO title for the collection. - **seo_description** (string) - The SEO description for the collection. - **seo_indexable** (boolean or null) - Indicates if the collection is indexable by search engines. - **social_image_id** (integer or null) - The ID of the social sharing image, if any. - **created_at** (string or null) - The timestamp when the collection was created. - **updated_at** (string or null) - The timestamp when the collection was last updated. #### Response Example ```json { "id": 5, "public_id": "RxuFTU", "workspace_id": 42000, "name": "Example Collection", "description": "Example Description", "collection_type": "manual", "product_ids": [], "sort_method": "manually", "archived": false, "image_id": null, "visible_in_store": true, "current_path": null, "seo_title": "Example SEO Title", "seo_description": "Example SEO Description", "seo_indexable": null, "social_image_id": null, "created_at": null, "updated_at": null } ``` #### Error Response (400) - **error** (string) - Description of the bad request. #### Error Response (401) - **error** (string) - Description of the unauthorized access. #### Error Response Example (401) ```json { "error": "API key missing or invalid" } ``` ``` -------------------------------- ### GET /products/{product_id}/prices Source: https://developers.myclickfunnels.com/reference/listproductsprices List all prices for a given product. This will include all prices for all variants of the product. You can also filter by variant_id to get prices for a specific variant. ```APIDOC ## GET /products/{product_id}/prices ### Description List all prices for a given product. This will include all prices for all variants of the product. You can also filter by variant_id to get prices for a specific variant. ### Method GET ### Endpoint /products/{product_id}/prices ### Parameters #### Path Parameters - **product_id** (integer) - Required - The ID of the product. #### Query Parameters - **after** (string) - Optional - ID of item after which the collection should be returned. - **sort_order** (string) - Optional - Sort order of a list response ('asc' or 'desc'). - **sort_property** (string) - Optional - Sort property of a list response ('id' or 'updated_at'). - **filter** (object) - Optional - Filter by available properties, e.g., filter[id]=value. ### Response #### Success Response (200) - **id** (integer) - Price ID - **public_id** (string) - Public ID - **variant_id** (integer) - Variant ID - **name** (string) - Price Name - **amount** (string) - Amount - **cost** (string) - Cost - **currency** (string) - Currency - **self_cancel** (boolean) - Self cancel flag - **self_upgrade** (boolean) - Self upgrade flag - **self_downgrade** (boolean) - Self downgrade flag - **self_reactivate** (boolean) - Self reactivate flag - **payment_type** (string) - Payment type - **visible** (boolean) - Visibility flag - **archived** (boolean/null) - Archived status - **created_at** (string) - Creation timestamp - **updated_at** (string) - Update timestamp #### Response Example { "id": 14, "public_id": "WpEGzF", "variant_id": 14, "name": "Example Price", "amount": "100.00", "cost": "0.00", "currency": "USD", "self_cancel": true, "self_upgrade": true, "self_downgrade": true, "self_reactivate": true, "payment_type": "one_time", "visible": true, "archived": false, "created_at": "2025-01-01T00:00:00.000Z", "updated_at": "2025-01-01T00:00:00.000Z" } ``` -------------------------------- ### Filter Query Parameter Syntax Source: https://developers.myclickfunnels.com/reference/listorders Demonstrates the syntax for applying filters to resource list requests. ```text api/v2/resources?filter[id]=value&filter[another_property]=value1,value2 ``` -------------------------------- ### Example Opportunity Stage Data Source: https://developers.myclickfunnels.com/reference/createsalespipelines This JSON structure represents an example of an opportunity stage within the MyClickFunnels API. It includes details such as ID, name, and associated opportunity IDs. ```json { "id": 53, "public_id": "KBhPxe", "workspace_id": 10, "pipeline_id": 8, "name": "Example Stage", "sort_order": 19, "close_probability": 20, "opportunity_ids": [ 39, 40 ], "total_value": 0, "weighted_value": 0 } ``` -------------------------------- ### GET /websites/developers_myclickfunnels/products Source: https://developers.myclickfunnels.com/reference/createproducts Retrieves a list of products. This endpoint is not fully detailed in the provided text, but it's implied by the context of product management. ```APIDOC ## GET /websites/developers_myclickfunnels/products ### Description Retrieves a list of products. Specific query parameters and response structure are not detailed in the provided text. ### Method GET ### Endpoint /websites/developers_myclickfunnels/products ``` -------------------------------- ### Sales Opportunities Note Attributes Example Source: https://developers.myclickfunnels.com/reference/createsalesopportunitiesnotes This example demonstrates the structure of a Sales Opportunities Note object, including its ID, content, and timestamps. It is used for retrieving note details. ```json { "id": 49, "public_id": "zAUjDv", "opportunity_id": 24, "content": "Example note", "created_by_id": 53, "created_at": "2025-01-01T00:00:00.000Z", "updated_at": "2025-01-01T00:00:00.000Z" } ``` -------------------------------- ### GET /websites/developers_myclickfunnels/products/{id} Source: https://developers.myclickfunnels.com/reference/createproducts Retrieves a specific product by its ID. Includes all product details. ```APIDOC ## GET /websites/developers_myclickfunnels/products/{id} ### Description Retrieves a specific product by its ID. This endpoint returns the full details of a product. ### Method GET ### Endpoint /websites/developers_myclickfunnels/products/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the product ``` -------------------------------- ### POST /workspaces/{workspace_id}/products Source: https://developers.myclickfunnels.com/reference/createproducts Create a new product within a specified workspace. This endpoint allows for the addition of detailed product information, including its name, visibility settings, SEO details, images, and variant properties. ```APIDOC ## POST /workspaces/{workspace_id}/products ### Description Add a new product to a workspace. ### Method POST ### Endpoint /workspaces/{workspace_id}/products ### Parameters #### Path Parameters - **workspace_id** (integer) - Required - The ID of the workspace to which the product will be added. #### Request Body - **product** (object) - Required - Information about the new product. - **name** (string) - Required - The name of the product. - **current_path** (string) - Optional - The current path of the product. - **visible_in_store** (boolean) - Optional - Whether the product is visible in the store. - **visible_in_customer_center** (boolean) - Optional - Whether the product is visible in the customer center. - **seo_title** (string) - Optional - The SEO title for the product. - **seo_description** (string) - Optional - The SEO description for the product. - **seo_image_id** (string) - Optional - The ID of the SEO image for the product. - **commissionable** (boolean) - Optional - Whether the product is commissionable. - **image_ids** (array) - Optional - An array of image IDs for the product. - **redirect_funnel_id** (string) - Optional - The ID of the funnel to redirect to. - **cancellation_funnel_url** (string) - Optional - The URL of the cancellation funnel. - **tag_ids** (array) - Optional - An array of tag IDs to associate with the product. To avoid losing existing tags, first use the Fetch Product endpoint and include existing tags along with new ones. - **variant_properties** (array) - Optional - The properties of the product's variants (e.g., 'Size', 'Color'). Each item is an object with: - **id** (integer) - Optional - The ID of the property if updating. - **name** (string) - Required - The name of the property. ### Request Example ```json { "product": { "name": "Sample Product", "current_path": null, "visible_in_store": true, "visible_in_customer_center": true, "seo_title": "Buy Sample Product Online", "seo_description": "This is a sample product.", "seo_image_id": null, "commissionable": true, "image_ids": [], "redirect_funnel_id": null, "cancellation_funnel_url": null, "tag_ids": [ 1, 2, 3 ], "variant_properties": [ { "id": 1, "name": "Size" }, { "id": 2, "name": "Color" } ] } } ``` ### Response #### Success Response (201) - **id** (integer) - The unique identifier for the created product. - **public_id** (string) - The public-facing identifier for the product. - **workspace_id** (integer) - The ID of the workspace the product belongs to. - **name** (string) - The name of the product. - **current_path** (string) - The current path of the product. - **archived** (boolean) - Indicates if the product is archived. - **visible_in_store** (boolean) - Indicates if the product is visible in the store. - **visible_in_customer_center** (boolean) - Indicates if the product is visible in the customer center. - **image_id** (string) - The ID of the main product image. - **seo_title** (string) - The SEO title for the product. - **seo_description** (string) - The SEO description for the product. - **seo_image_id** (string) - The ID of the SEO image for the product. - **commissionable** (boolean) - Indicates if the product is commissionable. #### Response Example ```json { "id": 129, "public_id": "IshNin", "workspace_id": 42000, "name": "Sample Product", "current_path": null, "archived": false, "visible_in_store": true, "visible_in_customer_center": true, "image_id": null, "seo_title": "Buy Sample Product Online", "seo_description": "This is a sample product.", "seo_image_id": null, "commissionable": true } ``` ```