Skip to main content
PATCH
/
groups
/
{uniqid}
Update group
curl --request PATCH \
  --url https://api.shoppex.io/dev/v1/groups/{uniqid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "isUnlisted": true,
  "productsBound": [
    "<string>"
  ],
  "sortOrder": 123,
  "removeImage": true
}
'
{
  "data": {
    "id": "<string>",
    "uniqid": "<string>",
    "shop_id": "<string>",
    "title": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "image_url": "<string>",
    "position": 123,
    "product_count": 123,
    "products_bound": [
      "<string>"
    ],
    "created_at": 123,
    "updated_at": 123
  }
}

Authorizations

Authorization
string
header
required

Use your API key with the Bearer scheme. Get your key from Dashboard → Settings → API Keys. Format: Authorization: Bearer shx_...

Path Parameters

uniqid
string
required

Group uniqid

Body

application/json
title
string
Required string length: 1 - 64
isUnlisted
boolean
productsBound
string[]
sortOrder
integer
removeImage
boolean

Response

Default Response

data
object
required