Carregar uma imagem da marca
Carrega uma imagem da marca, que substitui a que havia, e devolve a marca. O corpo é a própria imagem, não JSON.
Executa a chamada real no seu espaço de trabalho.
PUT /branding/images/{variant}
Carrega uma imagem da marca, que substitui a que havia, e devolve a marca. O corpo é a própria imagem, não JSON.
As quatro imagens
| variant | O que é | Formatos | Guardada como |
|---|---|---|---|
| mark | O ícone quadrado | SVG, PNG, JPEG, WebP | WebP, no máximo 512 por 512 |
| wordmark | O logótipo | SVG, PNG, JPEG, WebP | WebP, no máximo 1024 por 256 |
| wordmark-dark | O logótipo para o modo escuro | SVG, PNG, JPEG, WebP | WebP, no máximo 1024 por 256 |
| login-background | A foto por trás da página de início de sessão | PNG, JPEG, WebP, GIF | WebP, no máximo 2560 por 1600 |
Envie os bytes com o tipo em Content-Type. Aceita-se até 5 MB. Um SVG é convertido numa imagem, e uma imagem animada fica com a primeira moldura.
Exemplo
Requer settings:write e uma chave sem restrição de endereço ou domínio.
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 }}Carregar a foto de início de sessão também muda a página de início de sessão para ela.
Uma imagem de um tipo que essa variante não aceita, ou que não pode ser lida, responde 422 invalid_image. Um serviço de imagens ocupado responde 503 image_busy, e uma gravação falhada 502 image_not_stored, por isso tente de novo.