Update collection

PATCH

/collections/{handle}

curl --request PATCH \
  --url 'https://acme.mykreezalid.com/api/v1/collections/example?by=handle' \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "handle": "soldes", "title": "Promotions de Printemps", "metadata": { "last_updated_at": "2025-07-01T10:00:00Z", "theme": "blue" }, "parent_handle": "promos", "storefront_enabled": true, "is_online": true, "type": "listing", "page_title": "Voitures électriques", "subtitle": null, "description": null, "image_alt": null, "rules": null, "template": null, "thumbnail": null, "canonical_url": null, "meta_title": null, "meta_description": null, "meta_keywords": null, "no_index": false, "no_follow": false, "sitemap_changefreq": null, "sitemap_priority": null }'

• Your marketplace's address. A marketplace with a custom domain must be called on that domain instead (https://developers.kreezalid.com/getting-started/base-urls/).

Updates the fields sent, and only those. Besides the integrator’s fields (title, metadata, handle), a collection’s page can be written: the storefront switch, texts, SEO, indexing and conditions, checked as the back office checks them. A storefront collection never takes an address a page, a route or another collection holds, and one that changes address redirects from the old one. On a collection made by a model, the conditions and the type are its model’s and are refused here; every other inherited field takes null for the model’s pattern, an empty string for nothing on purpose, or its own value (never an empty name). The image is uploaded through the back office only.

Authorizations

• basic

Parameters

Path Parameters

handle

required

string

The handle (slug) of the collection, or its id with by=id

Query Parameters

by

string

default: handle

Allowed values: handle id

How the path names the collection: handle (the default, which also finds an integrator’s source handle) or id. A handle may be made of digits only, so an id is never guessed.

Request Body^required

Media typeapplication/json

Collection

Represents a logical group of listings, such as construction projects or promotions, or a storefront page presenting listings or users. A collection made by a collection model follows its model’s conditions; its fields left null show the model’s patterns.

object

id

Collection’s unique identifier

integer

Example

432432

handle

required

URL-friendly identifier for the collection (slug)

string

Example

soldes

title

required

Human-readable title of the collection

string

Example

Promotions de Printemps

metadata

Flexible metadata container for the collection

object

Example

{
  "last_updated_at": "2025-07-01T10:00:00Z",
  "theme": "blue"
}

parent_handle

Handle of the parent collection, if this is a sub-collection. It is not returned in responses: list a parent’s sub-collections with GET /collections/{parent_handle}.

string

nullable

Example

promos

storefront_enabled

Whether the collection is a storefront page, at /{handle}

boolean

Example

true

is_online

Whether its page is online

boolean

Example

true

type

What it presents: listing or user

string

Example

listing

page_title

The title its page shows. On a collection made by a model: null for the model’s pattern, empty for nothing, or its own

string

nullable

Example

Voitures électriques

subtitle

Same three states as page_title

string

nullable

Example

null

description

HTML; same three states as page_title

string

nullable

Example

null

image_alt

Alternative text of the image (the image itself is uploaded in the back office)

string

nullable

Example

null

rules

Its conditions: inclusion {type: AND or OR, rules: […]} and exclusion […]. Read-only on a collection made by a model

object

Example

null

template

Suffix of the theme’s collection template; empty, the default one

string

nullable

Example

null

thumbnail

Snippet drawing each item; empty, the default card of its type

string

nullable

Example

null

canonical_url

Full URL; never inherited

string

nullable

Example

null

meta_title

SEO title

string

nullable

Example

null

meta_description

SEO description

string

nullable

Example

null

meta_keywords

SEO keywords

string

nullable

Example

null

no_index

Kept out of search engines; null on a collection made by a model: as the model

boolean

nullable

Example

false

no_follow

Links not followed; null on a collection made by a model: as the model

boolean

nullable

Example

false

sitemap_changefreq

Always, hourly, daily, weekly, monthly, yearly or never

string

nullable

Example

null

sitemap_priority

From 0 to 1

number

nullable

Example

null

model_id

The id of the collection model it is made by; read-only

integer

nullable

Example

null

model_handle

The handle of that model; read-only

string

nullable

Example

null

pivot_value

The model’s value it stands for; read-only

string

nullable

Example

null

pivot_label

The label of that value; read-only

string

nullable

Example

null

model_pivot

The criterion its model varies on: type, field (an attribute’s alias) and a readable name

object

Example

{
  "type": "attribute",
  "field": "marque",
  "name": "Marque"
}

created_at

Collection creation date

string format: date-time

Example

2025-07-20T10:30:00Z

updated_at

Date of last update

string format: date-time

Example

2025-07-20T14:45:00Z

Responses

200

Collection successfully updated

Media typeapplication/json

Collection

Represents a logical group of listings, such as construction projects or promotions, or a storefront page presenting listings or users. A collection made by a collection model follows its model’s conditions; its fields left null show the model’s patterns.

object

id

Collection’s unique identifier

integer

handle

required

URL-friendly identifier for the collection (slug)

string

title

required

Human-readable title of the collection

string

metadata

Flexible metadata container for the collection

object

parent_handle

Handle of the parent collection, if this is a sub-collection. It is not returned in responses: list a parent’s sub-collections with GET /collections/{parent_handle}.

string

nullable

storefront_enabled

Whether the collection is a storefront page, at /{handle}

boolean

is_online

Whether its page is online

boolean

type

What it presents: listing or user

string

page_title

The title its page shows. On a collection made by a model: null for the model’s pattern, empty for nothing, or its own

string

nullable

subtitle

Same three states as page_title

string

nullable

description

HTML; same three states as page_title

string

nullable

image_alt

Alternative text of the image (the image itself is uploaded in the back office)

string

nullable

rules

Its conditions: inclusion {type: AND or OR, rules: […]} and exclusion […]. Read-only on a collection made by a model

object

template

Suffix of the theme’s collection template; empty, the default one

string

nullable

thumbnail

Snippet drawing each item; empty, the default card of its type

string

nullable

canonical_url

Full URL; never inherited

string

nullable

meta_title

SEO title

string

nullable

meta_description

SEO description

string

nullable

meta_keywords

SEO keywords

string

nullable

no_index

Kept out of search engines; null on a collection made by a model: as the model

boolean

nullable

no_follow

Links not followed; null on a collection made by a model: as the model

boolean

nullable

sitemap_changefreq

Always, hourly, daily, weekly, monthly, yearly or never

string

nullable

sitemap_priority

From 0 to 1

number

nullable

model_id

The id of the collection model it is made by; read-only

integer

nullable

model_handle

The handle of that model; read-only

string

nullable

pivot_value

The model’s value it stands for; read-only

string

nullable

pivot_label

The label of that value; read-only

string

nullable

model_pivot

The criterion its model varies on: type, field (an attribute’s alias) and a readable name

object

created_at

Collection creation date

string format: date-time

updated_at

Date of last update

string format: date-time

Example

{
  "id": 432432,
  "handle": "soldes",
  "title": "Promotions de Printemps",
  "metadata": {
    "last_updated_at": "2025-07-01T10:00:00Z",
    "theme": "blue"
  },
  "parent_handle": "promos",
  "storefront_enabled": true,
  "is_online": true,
  "type": "listing",
  "page_title": "Voitures électriques",
  "subtitle": null,
  "description": null,
  "image_alt": null,
  "rules": null,
  "template": null,
  "thumbnail": null,
  "canonical_url": null,
  "meta_title": null,
  "meta_description": null,
  "meta_keywords": null,
  "no_index": false,
  "no_follow": false,
  "sitemap_changefreq": null,
  "sitemap_priority": null,
  "model_id": null,
  "model_handle": null,
  "pivot_value": null,
  "pivot_label": null,
  "model_pivot": {
    "type": "attribute",
    "field": "marque",
    "name": "Marque"
  },
  "created_at": "2025-07-20T10:30:00Z",
  "updated_at": "2025-07-20T14:45:00Z"
}

400

Refused or invalid: message says why, errors field by field

Media typeapplication/json

Why a collection or collection model request was refused.

object

success

boolean

message

string

errors

The problems found: for a collection, field by field, the rules not met and their messages. Present only when there are some.

Example

{
  "success": false,
  "message": "Collection handle is required"
}

404

Collection not found

Media typeapplication/json

Why a collection or collection model request was refused.

object

success

boolean

message

string

errors

The problems found: for a collection, field by field, the rules not met and their messages. Present only when there are some.

Example

{
  "success": false,
  "message": "Collection handle is required"
}