Die Schriften und den Anmeldehintergrund ändern
Ändert die Schriften, den Hintergrund der Anmeldeseite oder beides und gibt die Marke zurück. Ein weggelassenes Feld behält seinen Wert.
Führt den echten Aufruf in Ihrem Workspace aus.
PATCH /branding
Ändert die Schriften, den Hintergrund der Anmeldeseite oder beides und gibt die Marke zurück. Ein weggelassenes Feld behält seinen Wert.
Die Anfrage
Parameter
fontsobject- Die zu ändernden Schriften, als `primary`, `secondary` oder beide. Jede ist eine Schrift-ID oder null für die Standardschrift, und eine weggelassene Schrift behält ihren Wert.
loginBackgroundobject | null- Der Hintergrund der Anmeldeseite, der den bisherigen ersetzt, oder null für den Standard. `kind` ist `preset`, `color` oder `image`. `preset` ist einer von `dusk`, `mist`, `sand`, `night` und für `kind: "preset"` erforderlich. `color` ist `#` und sechs Hexadezimalziffern und für `kind: "color"` erforderlich. Der Wert für die andere Art darf mitgeschickt werden und bleibt erhalten, sodass ein Zurückwechseln ihn wiederherstellt.
Beispiel
Erfordert settings:write und einen Key ohne Adress- oder Domain-Beschränkung.
curl -X PATCH "$OE/branding" -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "loginBackground": { "kind": "color", "preset": "dusk", "color": "#1f2937" } }'{ "object": "branding", "editable": true, "images": { "mark": "https://cdn-prod.openemail.uk/workspaces/icons/0199a1c2-7d4e-7a31-9b52-3c8e1f0a6d24.webp", "wordmark": "https://cdn-prod.openemail.uk/workspaces/wordmarks/0199a1c2-8b10-7e45-a2f1-6d9c3b7e0f58.webp", "wordmarkDark": null, "loginBackground": null }, "fonts": { "primary": "inter", "secondary": "georgia" }, "loginBackground": { "kind": "color", "preset": "dusk", "color": "#1f2937" }}kind: "image" zeigt das mit PUT /branding/images/login-background hochgeladene Foto, und der Hintergrund liest sich als null, bis eines hochgeladen ist. Ein Upload stellt die Seite von selbst darauf um.
Eine Schrift, die nicht auf der Liste steht, ein preset-Hintergrund ohne Vorlage oder eine Farbe, die nicht aus # und sechs Hexadezimalziffern besteht, wird mit 422 invalid_parameter beantwortet, und param nennt das Feld. Ein persönlicher Bereich wird mit 409 branding_unavailable beantwortet.