Update a Collection

PATCH

api

v202604

company

collections

{id}

curl --request PATCH \
  --url https://api.fluid.app/api/v202604/company/collections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection": {
    "status": "published",
    "active": true
  }
}
'

{
  "status": 200,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 25,
      "prev_cursor": "<string>",
      "next_cursor": "<string>"
    }
  },
  "collection": {
    "id": 5102,
    "slug": "wellness-essentials",
    "title": "Wellness Essentials",
    "description": "Hand-picked supplements and recovery gear.",
    "image_url": "https://cdn.fluid.app/collections/5102.png",
    "canonical_url": "https://acme.fluid.app/home/collections/wellness-essentials",
    "images": {
      "thumb": {
        "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
        "width": 600
      },
      "medium": {
        "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
        "width": 600
      },
      "large": {
        "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
        "width": 600
      }
    },
    "active": true,
    "status": "published",
    "publish_at": null,
    "seo": {
      "title": "Summer Sale — Up to 40% Off",
      "description": "Shop the July clearance event before it ends.",
      "image_url": "https://ik.imagekit.io/fluidapp/tr:w-1200,h-630,c-maintain_ratio,fo-auto,f-auto,q-80/seo/9215.png",
      "block_crawler": false,
      "id": 9215
    },
    "metafields": [
      {
        "namespace": "custom",
        "key": "material",
        "value": "<unknown>",
        "value_type": "single_line_text_field",
        "description": "The primary material used in this product",
        "created_at": "2026-05-01T12:00:00Z",
        "updated_at": "2026-05-01T12:00:00Z",
        "locked": false
      }
    ],
    "languages": [
      "en",
      "fr"
    ],
    "countries": [
      "GB",
      "US"
    ],
    "custom_slug": false
  }
}

{
  "message": "Invalid credentials."
}

{
  "error": "Not authorized."
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 25,
      "prev_cursor": "<string>",
      "next_cursor": "<string>"
    }
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 25,
      "prev_cursor": "<string>",
      "next_cursor": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Accepts company-admin tokens with storefront.view for read operations and storefront.update for writes and scan triggers (legacy per-resource grants like categories.update / products.view / etc. are still accepted during the migration), required on every company operation. Storefront public operations under /api/v202604/{resource} and /api/v202604/{resource}/{slug} are unauthenticated (security: []).

Path Parameters

integer

required

The unique identifier of the collection.

Query Parameters

lang

string

Response locale. ISO code (e.g. fr, de). When omitted, responds in the company's default locale. On the public surface, falls back to en for any translated field missing in the requested locale.

Example:

"fr"

Body

application/json

collection

object

required

Show child attributes

Response

The updated Collection.

Shared success envelope for list / show / create / update responses: the resource payload is returned alongside a top-level integer status and meta. Composed onto each resource response via allOf.

status

integer

required

Example:

200

meta

object

required

Response metadata included on every successful response body. request_id and timestamp are always present; list endpoints also add pagination.

Show child attributes

collection

object

required

Authenticated (company-surface) Collection read shape: the public CollectionBase plus custom_slug, admin metadata never rendered on the public surface.

Show child attributes

Destroy a Collection

Share statistics for a Collection

curl --request PATCH \
  --url https://api.fluid.app/api/v202604/company/collections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection": {
    "status": "published",
    "active": true
  }
}
'

{
  "status": 200,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 25,
      "prev_cursor": "<string>",
      "next_cursor": "<string>"
    }
  },
  "collection": {
    "id": 5102,
    "slug": "wellness-essentials",
    "title": "Wellness Essentials",
    "description": "Hand-picked supplements and recovery gear.",
    "image_url": "https://cdn.fluid.app/collections/5102.png",
    "canonical_url": "https://acme.fluid.app/home/collections/wellness-essentials",
    "images": {
      "thumb": {
        "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
        "width": 600
      },
      "medium": {
        "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
        "width": 600
      },
      "large": {
        "url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png",
        "width": 600
      }
    },
    "active": true,
    "status": "published",
    "publish_at": null,
    "seo": {
      "title": "Summer Sale — Up to 40% Off",
      "description": "Shop the July clearance event before it ends.",
      "image_url": "https://ik.imagekit.io/fluidapp/tr:w-1200,h-630,c-maintain_ratio,fo-auto,f-auto,q-80/seo/9215.png",
      "block_crawler": false,
      "id": 9215
    },
    "metafields": [
      {
        "namespace": "custom",
        "key": "material",
        "value": "<unknown>",
        "value_type": "single_line_text_field",
        "description": "The primary material used in this product",
        "created_at": "2026-05-01T12:00:00Z",
        "updated_at": "2026-05-01T12:00:00Z",
        "locked": false
      }
    ],
    "languages": [
      "en",
      "fr"
    ],
    "countries": [
      "GB",
      "US"
    ],
    "custom_slug": false
  }
}

{
  "message": "Invalid credentials."
}

{
  "error": "Not authorized."
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 25,
      "prev_cursor": "<string>",
      "next_cursor": "<string>"
    }
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 25,
      "prev_cursor": "<string>",
      "next_cursor": "<string>"
    }
  }
}

Overview

Task guides

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Update a Collection

Authorizations

Path Parameters

Query Parameters

Body

Response