Update Collection

put https://{subdomain}.myclickfunnels.com/api/v2/products/collections/{id}

Update Collection

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

integer

required

Numeric ID of the collection

public_id

string | null

Public ID is a string version of the numeric ID

workspace_id

integer

required

ID reference to the workspace to which the collection belongs

name

string

required

Name of the products collection

description

string | null

Description of the collection

collection_type

string | null

Type of the collection (manual or automatic)

product_ids

array | null

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.

product_ids

sort_method

string | null

Method used to sort the products in the collection

manually name_asc name_desc price_desc price_asc added_at_desc added_at_asc created_at_desc created_at_asc

archived

boolean | null

Whether the collection is archived

image_id

string | null

Collection image

visible_in_store

boolean | null

Whether the collection is visible in the online store

current_path

string | null

Current path of the collection

seo_title

string | null

Title of the collection for SEO purposes

seo_description

string | null

Description of the collection for SEO purposes

seo_indexable

string | null

Whether the collection is indexable by search engines

social_image_id

string | null

Image for social sharing

created_at

string | null

Date and time the collection was created

updated_at

string | null

Date and time the collection was last updated

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://myworkspace.myclickfunnels.com/api/v2/products/collections/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
20
 
1
{
2
  "id": 7,
3
  "public_id": "xzfyUm",
4
  "workspace_id": 42000,
5
  "name": "Example Collection",
6
  "description": "Example Description",
7
  "collection_type": "manual",
8
  "product_ids": [],
9
  "sort_method": "manually",
10
  "archived": false,
11
  "image_id": null,
12
  "visible_in_store": true,
13
  "current_path": null,
14
  "seo_title": "Example SEO Title",
15
  "seo_description": "Example SEO Description",
16
  "seo_indexable": null,
17
  "social_image_id": null,
18
  "created_at": null,
19
  "updated_at": null
20
}

200OK

400Bad Request

401Unauthorized

404Not Found