MYmyclickfunnels
Product

Archive a Product

This will archive a Product. A product can only be archived if it's not in the "live" state.

post/products/{id}/archive

Request

Path parameters

idstring required

Response

OK

idinteger

ID

public_idstring nullable

Product Public ID

workspace_idinteger

Workspace ID

namestring

Product name

current_pathstring nullable

Current Path

archivedboolean nullable

Archived

visible_in_storeboolean nullable

Visible in Store

visible_in_customer_centerboolean nullable

Visible in Customer Center

image_idstring nullable

Image

seo_titlestring nullable

A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters.

seo_descriptionstring nullable

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).

seo_image_idstring nullable

SEO image

commissionableboolean nullable

Commissionable

default_variant_idinteger

The ID of the default variant of the product

redirect_funnel_idstring nullable

Redirect funnel

cancellation_funnel_urlstring nullable

Cancellation Funnel Url

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

{
  "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"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.