API
브랜드 이미지 업로드
브랜드 이미지 하나를 업로드해 기존 이미지를 대체하고 브랜드를 반환합니다. 본문은 JSON이 아니라 이미지 자체입니다.
PUT/branding/images/{variant}
워크스페이스에 실제 호출을 실행합니다.
PUT /branding/images/{variant}
브랜드 이미지 하나를 업로드해 기존 이미지를 대체하고 브랜드를 반환합니다. 본문은 JSON이 아니라 이미지 자체입니다.
이미지 네 개
| variant | 설명 | 형식 | 저장 형식 |
|---|---|---|---|
| mark | 정사각형 아이콘 | SVG, PNG, JPEG, WebP | WebP, 최대 512 × 512 |
| wordmark | 로고 | SVG, PNG, JPEG, WebP | WebP, 최대 1024 × 256 |
| wordmark-dark | 다크 모드용 로고 | SVG, PNG, JPEG, WebP | WebP, 최대 1024 × 256 |
| login-background | 로그인 페이지 뒤의 사진 | PNG, JPEG, WebP, GIF | WebP, 최대 2560 × 1600 |
바이트를 Content-Type에 형식을 담아 보내세요. 최대 5MB까지 받습니다. SVG는 그림으로 변환되며, 움직이는 이미지는 첫 프레임만 남습니다.
예시
settings:write와, 주소나 도메인 제한이 없는 키가 필요합니다.
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 }}로그인 사진을 업로드하면 로그인 페이지도 그 사진으로 바뀝니다.
해당 종류가 받지 않는 형식의 이미지나 읽을 수 없는 이미지는 422 invalid_image로 응답합니다. 이미지 서비스가 바쁘면 503 image_busy, 저장에 실패하면 502 image_not_stored로 응답하니 다시 시도하세요.
