API
フォントとログインページの背景を変更する
フォント、ログインページの背景、またはその両方を変更し、ブランドを返します。省略したフィールドは値を保ちます。
PATCH/branding
実際の呼び出しをワークスペースに対して実行します。
PATCH /branding
フォント、ログインページの背景、またはその両方を変更し、ブランドを返します。省略したフィールドは値を保ちます。
リクエスト
パラメーター
fontsobject- 変更するフォントで、`primary`、`secondary`、またはその両方です。それぞれフォント ID か、デフォルトを表す null で、省略したフォントは値を保ちます。
loginBackgroundobject | null- ログインページの背景で、それまでの背景を置き換えます。null にするとデフォルトになります。`kind` は `preset`、`color`、`image` のいずれかです。`preset` は `dusk`、`mist`、`sand`、`night` のいずれかで、`kind: "preset"` のときに必須です。`color` は `#` と 16 進数 6 桁で、`kind: "color"` のときに必須です。もう一方の種類の値も一緒に送ることができ、保持されるので、切り替えて戻すと復元されます。
例
settings:write と、アドレスやドメインの制限がないキーが必要です。
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" は PUT /branding/images/login-background でアップロードした写真を表示し、写真がアップロードされるまで背景は null として読み取られます。写真をアップロードすると、ページは自動的にその写真に切り替わります。
リストにないフォント、プリセットのない preset の背景、# と 16 進数 6 桁ではない色は 422 invalid_parameter を返し、param がフィールドを示します。個人スペースは 409 branding_unavailable を返します。
