Alterar os tipos de letra e o fundo de início de sessão
Altera os tipos de letra, o fundo da página de início de sessão ou ambos, e devolve a marca. Um campo omitido mantém o seu valor.
Executa a chamada real no seu espaço de trabalho.
PATCH /branding
Altera os tipos de letra, o fundo da página de início de sessão ou ambos, e devolve a marca. Um campo omitido mantém o seu valor.
O pedido
Parâmetros
fontsobject- Os tipos de letra a alterar, como `primary`, `secondary` ou ambos. Cada um é um id de tipo de letra ou null para o predefinido, e um tipo de letra omitido mantém o seu valor.
loginBackgroundobject | null- O fundo da página de início de sessão, que substitui o que havia, ou null para o predefinido. `kind` é `preset`, `color` ou `image`. `preset` é um de `dusk`, `mist`, `sand`, `night` e é obrigatório com `kind: "preset"`. `color` é `#` e seis dígitos hexadecimais e é obrigatório com `kind: "color"`. O valor do outro tipo também pode ser enviado e é guardado, por isso voltar a ele restaura-o.
Exemplo
Requer settings:write e uma chave sem restrição de endereço ou domínio.
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" mostra a foto carregada com PUT /branding/images/login-background, e o fundo lê-se como null até haver uma. Carregar uma muda a página para ela automaticamente.
Um tipo de letra que não está na lista, um fundo preset sem fundo predefinido ou uma cor que não é # e seis dígitos hexadecimais responde 422 invalid_parameter, com param a nomear o campo. Um espaço pessoal responde 409 branding_unavailable.