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. يُقبل حتى 5 ميغابايت. يتحوّل ملف 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، فأعد المحاولة.
