Update category

Update a category (POST body is partial). Requires a Write key. Empty allowStore or hideStore arrays remove the field.

POST/categories/{categoryId}

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Path parameters

categoryIdstringrequired

Request body

requiredapplication/json

namestring

indexnumber

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

hideStorestring[]

Empty array removes the field.

allowStorestring[]

Empty array removes the field.

deletedboolean

Set true to soft-delete.

Responses

200Updated

successbooleanrequired

400Bad request

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

pathstringrequired

Request path

403Unauthorized

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

pathstringrequired

Request path

404Not found

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

pathstringrequired

Request path

Request

curl -X POST "https://dashboard.scango.ch/api/v1/categories/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "index": 0,
  "showOnScreen": true,
  "imageUrl": "string",
  "marginMinPercent": 0,
  "marginMaxPercent": 0,
  "hideStore": [
    "string"
  ],
  "allowStore": [
    "string"
  ],
  "deleted": true
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/categories/string", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "name": "string",
  "index": 0,
  "showOnScreen": true,
  "imageUrl": "string",
  "marginMinPercent": 0,
  "marginMaxPercent": 0,
  "hideStore": [
    "string"
  ],
  "allowStore": [
    "string"
  ],
  "deleted": true
})
});

Response

{
  "success": true
}