Die Benutzer-Schnittstelle der REST-API unterstützt ab sofort weitere Benutzerattribute, darunter Anrede, Sprache, Adresse, benutzerdefinierte Felder und Personalnummer.

Die neuen Felder werden beim Abruf über GET /users und GET /users/{userId} zurückgegeben. Sie können beim Anlegen über POST /users und beim Aktualisieren über PATCH /users/{userId} gesetzt werden:

• salutation – Anrede, zulässige Werte mr, ms und divers
  • mr = Herr
  • ms = Frau 
  • divers =  Neutrale Anrede
• role – Rolle als Freitext
• job_title – Jobbezeichnung als Freitext
• lang – Sprache des Benutzers. Zur Auswahl stehen de und en
  • en = Englisch
  • de = Deutsch
• custom_1 bis custom_4 – Freitextfelder am User
• address – Objekt mit street, zipcode, city, region, country_code, location_phone und intermediate_recipient_name
• account.employee_number – Personalnummer als Freitext

Nicht gesetzte Textfelder werden als leere Zeichenkette zurückgegeben, nicht als null.

Anrede: Der Wert wird unabhängig von Groß- und Kleinschreibung erkannt und in Kleinbuchstaben zurückgegeben. Ein nicht zulässiger Wert führt nicht zu einem Fehler; die Anrede wird stattdessen leer gesetzt.

Sprache: In der Regel stehen de und en zur Verfügung. Bei einigen Anwendungen existiert nur Deutsch. Ein nicht angebotener Wert wird mit dem Statuscode 422 abgelehnt. Eine leere Zeichenkette oder null setzt die Sprache auf den Standard der Anwendung zurück. Da die Sprache am Login-Konto hinterlegt ist, gilt eine Änderung für alle Benutzer, die sich mit demselben Konto anmelden.

Adresse: Die Postleitzahl besteht aus bis zu fünf Ziffern. country_code erwartet einen ISO-3166-1-alpha-2-Code in Kleinbuchstaben, z. B. de. Ein nicht angebotener Wert wird mit 422 abgelehnt.

Beim Aktualisieren wird jedes Adressfeld einzeln übernommen. Nicht übermittelte Felder bleiben unverändert, eine leere Zeichenkette oder null leert das jeweilige Feld. Eine einmal angelegte Adresse kann nicht vollständig entfernt werden. Teilt sich der Benutzer die Adresse mit einem anderen Benutzer, etwa nach „Mehrfachrolle hinzufügen" in der Benutzerverwaltung, wirkt sich eine Änderung auf beide Benutzer aus.

Aktualisieren: Beim Aktualisieren sind alle Felder optional, und es werden nur die übermittelten Felder geändert. So lässt sich beispielsweise die Personalnummer anpassen, ohne die E-Mail-Adresse erneut zu übermitteln. Ist account oder address kein Objekt oder leer, wird die Anfrage mit dem Statuscode 400 abgelehnt.

Die vollständige Beschreibung der Schnittstelle finden Sie in der API-Dokumentation.