Update White Label Config
aidelly_update_white_label_configUpdate the agency's white-label branding, email settings, and visibility toggles. Returns the updated configuration with the current domain status. Custom domains are changed and verified in the Aidelly app, which validates domain ownership. Retry-safe: a repeat call with the same idempotency_key returns the original result.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | Optional body override for endpoints with sparse parameter schemas. | |
| query | No | Optional query overrides for endpoints with sparse parameter schemas. | |
| brand_id | No | ||
| logo_url | No | Light-mode square logo URL. | |
| hide_earn | No | Hide earnings/monetization surfaces from white-label clients. | |
| brand_name | No | Agency brand name shown to white-label clients. | |
| favicon_url | No | Favicon URL for branded pages. | |
| support_url | No | URL to agency support/help page. | |
| hide_rewards | No | Hide rewards and gamification surfaces. | |
| og_image_url | No | Open Graph image for social shares. | |
| workspace_id | No | Workspace to operate in: the `id` of a workspace returned by aidelly_list_workspaces. Optional for read operations; required when creating content. | |
| dark_logo_url | No | Dark-mode square logo URL. Falls back to logo_url if not set. | |
| help_menu_url | No | URL for in-app help menu links. | |
| primary_color | No | Hex color for primary brand color (e.g., | |
| support_email | No | Agency inbox email for white-label support submissions. | |
| watermark_url | No | Watermark image URL for reports. | |
| email_from_name | No | From name for branded emails. | |
| hide_tier_badge | No | Hide tier/plan badges. | |
| idempotency_key | Yes | ||
| button_text_color | No | Text/icon color on brand-colored buttons. 'auto' derives from luminance. | |
| sidebar_logo_mode | No | Sidebar rendering mode — square mark+text or full logo image. | |
| email_from_address | No | From email address for branded emails. Must be covered by one of your verified sending domains, or the request fails with 400 PUBLIC_API_WHITE_LABEL_SENDING_DOMAIN_UNVERIFIED. null clears it. | |
| logo_text_font_url | No | Custom font URL for logo text in mark_text mode (must use https). | |
| privacy_policy_url | No | Privacy policy URL for branded emails and legal links. | |
| saved_brand_preset | No | Optional saved branding preset snapshot. Set to null to clear the preset; omit to leave alone. | |
| watermark_settings | No | Watermark configuration object (null resets to defaults). | |
| terms_of_service_url | No | Terms of service URL for branded emails and legal links. | |
| hide_feature_requests | No | Hide feature request UI. | |
| logo_text_font_family | No | Font family name for logo text rendering. | |
| logo_text_font_format | No | Font file format (woff2, woff, ttf, or otf). | |
| sidebar_full_logo_url | No | Light-mode full sidebar logo URL (both mark and text). | |
| show_oauth_interstitial | No | Whether to show OAuth interstitial before social platform redirects. | |
| ai_credit_alert_templates | No | Your own subject and body for AI credit alert emails sent under your brand (only on white-label sends from a verified sending domain). Per kind: an object sets the wording, null resets it to the built-in wording, and an omitted kind is left alone. null for the whole field resets every kind. Variables (any letter case): {{workspace}}, {{brand}}, {{allocation}}, {{spend}}, {{remaining}}, {{percent}}, {{threshold}}, {{reset_date}}, {{manage_url}} (billing owner only; empty for everyone else), {{support_url}}. Unknown variables are rejected. | |
| sidebar_dark_full_logo_url | No | Dark-mode full sidebar logo URL. Falls back to sidebar_full_logo_url if not set. | |
| watermark_enabled_by_default | No | Whether to include watermark on newly generated reports. | |
| suppress_member_welcome_email | No | Tri-state override for member welcome emails. null = use plan default, true/false = explicit override. | |
| agency_staff_uses_custom_domain | No | Whether agency staff access Aidelly at a custom domain. |