PATCH
/
collections
/
{id}
curl --request PATCH \
  --url https://api.fabric.inc/v3/collections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": [
    {
      "op": "replace",
      "path": "/name",
      "value": "Color"
    }
  ]
}'

Authorizations

Authorization
string
headerrequired

S2S access token (JWT) from fabric Identity service (during Login)

Headers

x-fabric-tenant-id
string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-request-id
string

Unique request ID

Path Parameters

id
string
required

System-generated 24-character collection ID

Body

application/json

Collection details to be updated, including the name. Additionally, you can add, replace, or remove attributes of a collection or products associated with it.

data
object[]
required

Response

200 - application/json

Collection details

id
string

24-character system-generated collection ID

name
string

Non-localized collection name

localizedProperties
object

Localized details

isLocalizable
boolean

true: Collection name is translated into different languages or localized for different regions <br /> false: Collection name isn't localized Note: Refer to localizedProperties to get relevant details based on locale

isRoot
boolean

true: Collection is root category.<br /> false: Collection isn't a root category.

isActive
boolean

true: Collection is active <br /> false: Collection is inactive

attributes
object[]

Collection attributes

categoriesIncluded
object[]

List of categories included

categoriesExcluded
object[]

List of categories excluded

productAttributeFilters
object[]

Attribute filters applied to the category

children
object[]

Immediate children of the specified collection

updatedBy
string

Email of user who last updated the category

updatedAt
string

Time of last updated to category (UTC)

createdAt
string

Time of category creation (UTC)

Was this page helpful?

Update collectionUpdate collections up to 25