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진수 여섯 자리이며 `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진수 여섯 자리가 아닌 색상은 422 invalid_parameter로 응답하며, param이 해당 필드를 알려 줍니다. 개인 공간은 409 branding_unavailable로 응답합니다.
