API
تغيير الخطوط وخلفية تسجيل الدخول
يغيّر الخطوط أو خلفية صفحة تسجيل الدخول أو كليهما، ويعيد العلامة التجارية. الحقل المتروك يحتفظ بقيمته.
PATCH/branding
ينفّذ الاستدعاء الحقيقي على مساحة عملك.
PATCH /branding
يغيّر الخطوط أو خلفية صفحة تسجيل الدخول أو كليهما، ويعيد العلامة التجارية. الحقل المتروك يحتفظ بقيمته.
الطلب
المعاملات
fontsobject- الخطوط المراد تغييرها، `primary` أو `secondary` أو كلاهما. كل منها معرّف خط أو null للافتراضي، والخط المتروك يحتفظ بقيمته.
loginBackgroundobject | null- خلفية صفحة تسجيل الدخول، بدلًا من الخلفية السابقة، أو null للافتراضي. `kind` هو `preset` أو `color` أو `image`. `preset` أحد `dusk` و`mist` و`sand` و`night`، وهو مطلوب لـ `kind: "preset"`. `color` هو `#` وستة أرقام سداسية عشرية، وهو مطلوب لـ `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 بلا قيمة جاهزة، أو لون ليس # وستة أرقام سداسية عشرية، يُرد عليه بـ 422 invalid_parameter، ويسمّي param الحقل. والمساحة الشخصية يُرد عليها بـ 409 branding_unavailable.
