Skip to content

Patch My Tenant Branding

PATCH
/v1/tenants/my-tenant/branding

Update tenant branding defaults. Admin only.

TenantBrandingUpdate
object
org_legal_name
Any of:
string
<= 500 characters
org_display_name
Any of:
string
<= 255 characters
logo_primary_url
Any of:
string
logo_reversed_url
Any of:
string
favicon_url
Any of:
string
social_share_image_url
Any of:
string
color_primary
Any of:
string
<= 32 characters
color_secondary
Any of:
string
<= 32 characters
color_background
Any of:
string
<= 32 characters
color_header_bg
Any of:
string
<= 32 characters
color_text_body
Any of:
string
<= 32 characters
dark_mode_support
Any of:
DarkModeSupport
string
Allowed values: system always_light always_dark
font_heading
Any of:
string
<= 500 characters
font_body
Any of:
string
<= 500 characters
from_email_address
Any of:
string format: email
from_email_display_name
Any of:
string
<= 255 characters
reply_to_email
Any of:
string format: email
email_footer_physical_address
Any of:
string
email_signature_html
Any of:
string
social_links
Any of:
object
key
additional properties
string
donation_form_headline
Any of:
string
<= 500 characters
donation_form_subheadline
Any of:
string
default_ask_string
Any of:
Array<integer>
recurring_upsell_enabled
Any of:
boolean
cover_processing_fee_prompt
Any of:
boolean
post_donation_redirect_url
Any of:
string
impact_statement_enabled
Any of:
boolean
custom_css
Any of:
string

Successful Response

Response[TenantBrandingRead]
object
data
required
TenantBrandingRead
object
id
required
Id
string format: uuid
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
tenant_id
required
Tenant Id
string format: uuid
updated_by
required
Any of:
string
org_legal_name
required
Any of:
string
org_display_name
required
Any of:
string
logo_primary_url
required
Any of:
string
logo_reversed_url
required
Any of:
string
favicon_url
required
Any of:
string
social_share_image_url
required
Any of:
string
color_primary
required
Color Primary
string
color_secondary
required
Color Secondary
string
color_background
required
Color Background
string
color_header_bg
required
Color Header Bg
string
color_text_body
required
Color Text Body
string
dark_mode_support
required
Dark Mode Support
string
font_heading
required
Font Heading
string
font_body
required
Font Body
string
from_email_address
required
Any of:
string
from_email_display_name
required
Any of:
string
reply_to_email
required
Any of:
string
email_footer_physical_address
required
Any of:
string
email_signature_html
required
Any of:
string
social_links
required
Social Links
object
key
additional properties
any
donation_form_headline
required
Donation Form Headline
string
donation_form_subheadline
required
Any of:
string
default_ask_string
required
Default Ask String
Array<integer>
recurring_upsell_enabled
required
Recurring Upsell Enabled
boolean
cover_processing_fee_prompt
required
Cover Processing Fee Prompt
boolean
post_donation_redirect_url
required
Any of:
string
impact_statement_enabled
required
Impact Statement Enabled
boolean
custom_css
required
Any of:
string
meta
ResponseMeta

Metadata included in every response envelope.

object
request_id
Any of:
string
organization_id
Any of:
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object