Kundengruppe bearbeiten

Aktualisiert die Daten einer bestehenden Kundengruppe.

Request

PUT /api/oauth/v2/resource/customers/groups/{uuid}

Header

Header	Wert
Authorization	Bearer {access_token}
Content-Type	application/json

URL-Parameter

Parameter	Typ	Pflicht	Beschreibung
uuid	string (UUID)	Ja	Eindeutige ID der Kundengruppe

Body-Parameter

Hinweis: Alle Felder sind optional. Nicht übergebene Felder bleiben unverändert.

Feld	Typ	Pflicht	Beschreibung
name	string	Nein	Name der Kundengruppe (max. 50 Zeichen). Führende und nachfolgende Leerzeichen werden entfernt. Emojis und andere 4-Byte-Zeichen sind nicht erlaubt
description	string	Nein	Beschreibungstext. Emojis und andere 4-Byte-Zeichen sind nicht erlaubt
color	string	Nein	Farbe als Hex-Code (z.B. #74AFAD)

Wichtig: "description": null löscht die Beschreibung nicht. Ein explizit auf null gesetztes Feld wird wie ein nicht übergebenes Feld behandelt – die Response liefert trotzdem 200 OK, die bestehende Beschreibung bleibt unverändert. Um eine Beschreibung zu leeren, sende einen leeren String ("").

Erforderlicher Scope: customers

Response

Erfolg (200 OK)

{
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
    "name": "VIP-Kunden",
    "description": "Kunden mit Premium-Vertrag",
    "color": "#74AFAD"
  }
}

Response-Felder

Feld	Typ	Beschreibung
data.id	string (UUID)	Eindeutige ID der Kundengruppe
data.name	string	Name der Kundengruppe
data.description	string | null	Beschreibungstext
data.color	string	Farbe als Hex-Code

Beispiele

bash

curl -X PUT "https://my.offisy.at/api/oauth/v2/resource/customers/groups/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Muster GmbH",
    "description": "beispiel",
    "color": "beispiel"
  }'

Server

Client-ID

Client-Secret

Parameter

uuid *string

name string

description string

color string

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
400	validation_error	Ungültige Request-Daten (z.B. name zu lang oder name/description mit Emoji)
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope customers nicht vorhanden
403	access_denied	Zugriff durch fehlende Berechtigung verweigert
404	not_found	Kundengruppe nicht gefunden

Bei 400 liefert die Response ein JSON-Fehlerobjekt, z.B.:

{"error":"validation_error","error_description":"name must not exceed 50 characters."}

{"error":"validation_error","error_description":"description must not contain emoji or other 4-byte characters."}