Skip to main content
PUT
/
api
/
v1
/
hub
/
shop
/
{shopId}
/
collections
/
{collectionId}
Update Collection
curl --request PUT \
  --url https://api.getscale.ng/api/v1/hub/shop/{shopId}/collections/{collectionId} \
  --header 'Content-Type: application/json' \
  --header 'X-Shop-API-Key: <x-shop-api-key>' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "isActive": true
}
'
{
  "status": "success",
  "message": "Collection updated successfully"
}
Modifies collection naming, descriptions, toggle status, or display image assets. Accepts multipart form data.

​
Authorizations

​
X-Shop-API-Key
string
required
Your Secret API Key (sk_live_... or sk_test_...) generated from the Developer dashboard. Must be kept secret.

​
Path Parameters

​
shopId
string
required
The unique UUID of the shop.
​
collectionId
number
required
The unique collection ID.

​
Request Body (Multipart / Form Data)

​
name
string
Name of the collection.
​
slug
string
Alphanumeric URL slug.
​
description
string
Overview description.
​
isActive
boolean
Toggle whether this collection is visible.
​
image
file
Collection thumbnail image.
{
  "status": "success",
  "message": "Collection updated successfully"
}