تغییر قلمها و پسزمینهٔ ورود
قلمها، پسزمینهٔ صفحهٔ ورود یا هر دو را تغییر میدهد و برند را برمیگرداند. فیلدی که فرستاده نشود مقدارش را نگه میدارد.
فراخوانی واقعی را روی فضای کاری شما اجرا میکند.
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 میگیرد.