Ein Markenbild hochladen
Lädt ein Markenbild hoch, ersetzt das bisherige und gibt die Marke zurück. Der Body ist das Bild selbst, nicht JSON.
Führt den echten Aufruf in Ihrem Workspace aus.
PUT /branding/images/{variant}
Lädt ein Markenbild hoch, ersetzt das bisherige und gibt die Marke zurück. Der Body ist das Bild selbst, nicht JSON.
Die vier Bilder
| variant | Was es ist | Formate | Gespeichert als |
|---|---|---|---|
| mark | Das quadratische Symbol | SVG, PNG, JPEG, WebP | WebP, höchstens 512 × 512 |
| wordmark | Das Logo | SVG, PNG, JPEG, WebP | WebP, höchstens 1024 × 256 |
| wordmark-dark | Das Logo für den Dunkelmodus | SVG, PNG, JPEG, WebP | WebP, höchstens 1024 × 256 |
| login-background | Das Foto hinter der Anmeldeseite | PNG, JPEG, WebP, GIF | WebP, höchstens 2560 × 1600 |
Senden Sie die Bytes mit ihrem Typ in Content-Type. Bis zu 5 MB werden angenommen. Ein SVG wird in ein Bild umgewandelt, und ein animiertes Bild behält sein erstes Einzelbild.
Beispiel
Erfordert settings:write und einen Key ohne Adress- oder Domain-Beschränkung.
curl -X PUT "$OE/branding/images/login-background" -H "$AUTH" \ -H "Content-Type: image/jpeg" --data-binary @lobby.jpg{ "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": "https://cdn-prod.openemail.uk/workspaces/login-backgrounds/0199a1c3-0f2e-7c61-8d4a-5b1e9f7a2c36.webp" }, "fonts": { "primary": "inter", "secondary": "georgia" }, "loginBackground": { "kind": "image", "preset": "dusk", "color": null }}Das Hochladen des Anmeldebilds stellt auch die Anmeldeseite darauf um.
Ein Bild eines Typs, den diese Variante nicht annimmt, oder eines, das sich nicht lesen lässt, wird mit 422 invalid_image beantwortet. Ein ausgelasteter Bilddienst antwortet mit 503 image_busy und ein fehlgeschlagenes Speichern mit 502 image_not_stored, also versuchen Sie es erneut.
