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` का मान `#` और छह हेक्स अंक होता है, और `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 लौटाता है।
