Aggiorna categoria

Aggiorna una categoria (body POST parziale). Richiede una chiave Write. Gli array allowStore o hideStore vuoti rimuovono il campo.

POST/categories/{categoryId}

Autorizzazione

AutorizzazioneToken Bearer (API key) · headerobbligatorio

Chiave API dell'organizzazione.

Parametri path

categoryIdstringobbligatorio

Corpo della richiesta

obbligatorioapplication/json

namestring

indexnumber

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

hideStorestring[]

Un array vuoto rimuove il campo.

allowStorestring[]

Un array vuoto rimuove il campo.

deletedboolean

Imposta true per il soft-delete.

Risposte

200Aggiornato

successbooleanobbligatorio

400Richiesta non valida

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

pathstringobbligatorio

Percorso della richiesta

403Non autorizzato

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

pathstringobbligatorio

Percorso della richiesta

404Not found

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

pathstringobbligatorio

Percorso della richiesta

Richiesta

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

Risposta

{
  "success": true
}