Wir stellen die On-Premises API ein. Weitere Informationen und wie du auf unsere Cloud API der nächsten Generation migrieren kannst, findest du in unserem Dokument zur Einstellung der On-Premises API.
Unternehmensprofil-Einstellungen
/v1/settings/business/profile
Verwende den /v1/settings/business/profile-Endpunkt, um die folgenden Unternehmensprofil-Einstellungen zu konfigurieren: Unternehmensadresse, Unternehmensbeschreibung, E-Mail-Adresse für Unternehmenskontakt, Unternehmensbranche und Unternehmenswebsite.
Bevor du beginnst
- Du musst das
admin-Konto verwenden, um auf die Unternehmensprofil-Einstellungen zuzugreifen.
Abrufen
Tätige einen GET-Aufruf, um deine Unternehmensprofil-Einstellungen abzurufen.
Beispiel
GET /v1/settings/business/profile
Eine erfolgreiche Antwort enthält das Objekt profile, das die Unternehmensprofildaten umfasst. Genauere Beschreibungen der Daten findest du in der Parameterliste unten.
{
"settings": {
"business": {
"profile": {
"address": "new-business-address",
"description": "business-description",
"email": "new-business-email",
"vertical": "business-industry",
"websites": [ "website-1", "website-2" ]
}
}
}
Wenn Fehler auftreten, findest du weitere Informationen unter Fehlercodes und Statusmeldungen.
Aktualisieren von Unternehmensprofil-Einstellungen
Tätige einen POST-Aufruf, um deine Unternehmensprofil-Einstellungen zu aktualisieren.
Beispiel
POST /v1/settings/business/profile
{
"address": "your-business-address",
"description": "your-business-description",
"email": "your-business-email",
"vertical": "your-business-industry",
"websites": [ "your-website-1", "your-website-2" ]
}
Parameter
| Name | Beschreibung |
|---|---|
Typ: String | Adresse des Unternehmens. Max. 256 Zeichen. |
Typ: String | Beschreibung des Unternehmens. Max. 512 Zeichen. |
Typ: String | E-Mail-Adresse (in gültigem Format) des Unternehmens. Max. 128 Zeichen. |
Typ: String | Branche des Unternehmens. Muss einer der folgenden bestätigten Werte sein:
Die Unternehmensbranche kann nicht auf einen leeren Wert zurückgesetzt werden, nachdem sie einmal erstellt wurde. |
Typ: Array von Strings | URLs (einschließlich |
Teilweise Updates
Wenn du nur einige Felder mit neuen Informationen aktualisieren musst, kannst du eine Anfrage senden, mit der nur die notwendigen Felder geändert werden:
POST /v1/settings/business/profile
{
"address": "new-business-address",
"email": "new-business-email"
}
Eine erfolgreiche Anfrage gibt den HTTP-Statuscode 200 OK und entweder null oder {} zurück. Wenn Fehler auftreten, findest du weitere Informationen unter Fehlercodes und Statusmeldungen.