Archive a Product

post https://{subdomain}.myclickfunnels.com/api/v2/products/{id}/archive

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

Responses

Response body

object

integer

required

public_id

string | null

Product Public ID

workspace_id

integer

required

Workspace ID

name

string

required

Product name

current_path

string | null

Current Path

archived

boolean | null

Archived

visible_in_store

boolean | null

Visible in Store

visible_in_customer_center

boolean | null

Visible in Customer Center

image_id

string | null

Image

seo_title

string | null

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

seo_description

string | null

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_id

string | null

SEO image

commissionable

boolean | null

Commissionable

image_ids

array | null

Images

image_ids

default_variant_id

integer

required

The ID of the default variant of the product

variant_ids

array | null

Variant IDs

variant_ids

price_ids

array | null

Price IDs

price_ids

tag_ids

array | null

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)

tag_ids

redirect_funnel_id

string | null

Redirect funnel

cancellation_funnel_url

string | null

Cancellation Funnel Url

created_at

date-time | null

Added

updated_at

date-time | null

Updated

variant_properties

array of objects | null

Properties that are specific to the default variant of a product

variant_properties

object

integer

required

name

string

required

Name

404

Not Found

409

Conflict - occurs if product is already archived.

422

Unprocessable Entity

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://myworkspace.myclickfunnels.com/api/v2/products/id/archive \
3
     --header 'accept: application/json'


xxxxxxxxxx
23
 
1
{
2
  "id": 144,
3
  "public_id": "nQiXfU",
4
  "workspace_id": 42,
5
  "name": "Practical Marble Bottle d5cb42",
6
  "current_path": null,
7
  "archived": true,
8
  "visible_in_store": true,
9
  "visible_in_customer_center": true,
10
  "image_id": null,
11
  "seo_title": "Ea facere incidunt eos.",
12
  "seo_description": "Explicabo et minus repudiandae.",
13
  "seo_image_id": null,
14
  "commissionable": true,
15
  "image_ids": [],
16
  "variant_ids": [],
17
  "price_ids": [],
18
  "tag_ids": [],
19
  "redirect_funnel_id": null,
20
  "cancellation_funnel_url": null,
21
  "created_at": "2024-02-23T09:57:23.643Z",
22
  "updated_at": "2024-02-23T09:57:23.643Z"
23
}

200OK