Kategorie aktualisieren

Kategorie aktualisieren (POST-Body ist partiell). Erfordert einen Write-Key. Leere allowStore- oder hideStore-Arrays entfernen das Feld.

POST/categories/{categoryId}

Autorisierung

AutorisierungBearer-Token (API key) · headererforderlich

Organisations-API-Key.

Pfadparameter

categoryIdstringerforderlich

Request-Body

erforderlichapplication/json

namestring

indexnumber

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

hideStorestring[]

Leeres Array entfernt das Feld.

allowStorestring[]

Leeres Array entfernt das Feld.

deletedboolean

Auf true setzen zum Soft-Löschen.

Antworten

200Aktualisiert

successbooleanerforderlich

400Ungültige Anfrage

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

pathstringerforderlich

Request-Pfad

403Nicht autorisiert

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

pathstringerforderlich

Request-Pfad

404Not found

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

pathstringerforderlich

Request-Pfad

Anfrage

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: {
    "Autorisierung": "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
})
});

Antwort

{
  "success": true
}