Kundengruppe erstellen

Erstellt eine neue Kundengruppe.

Request

POST /api/oauth/v2/resource/customers/groups

Header

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

Body-Parameter

Feld	Typ	Pflicht	Beschreibung
name	string	Ja	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	Beschreibung der Kundengruppe. Emojis und andere 4-Byte-Zeichen sind nicht erlaubt
color	string	Nein	Farbe als Hex-Code (Format #RRGGBB, Standard: #74AFAD)

Hinweis: Der Name einer Kundengruppe ist nicht eindeutig. Jeder POST-Aufruf legt eine neue Kundengruppe an, auch wenn bereits eine Kundengruppe mit demselben Namen existiert. Ein wiederholt laufendes Sync-Skript erzeugt so Duplikate. Prüfe vor dem Anlegen per GET /customers/groups, ob die Kundengruppe schon existiert.

Response

Erfolg (201 Created)

{
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "Stammkunden",
    "description": "Kunden mit regelmäßigen Terminen",
    "color": "#74AFAD"
  }
}

Response-Felder

Siehe Kundengruppe anzeigen für die vollständige Feldbeschreibung.

Beispiele

bash

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

Server

Client-ID

Client-Secret

Parameter

name *string

description string

color string

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
400	validation_error	Ungültige Request-Daten
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope customers nicht vorhanden
403	access_denied	Der Besitzer-Benutzer deines API-Zugangs hat keine Berechtigung zum Erstellen von Kundengruppen in der Firma des OAuth-Clients (error_description: Insufficient permission for this resource.)

Beispiele für 400 validation_error:

{"error":"validation_error","error_description":"name is required."}

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

{"error":"validation_error","error_description":"color must be a hex value in the format #RRGGBB."}

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