Update workspace settings. Changes the workspace name, portal settings and branding: roadmap and changelog pages on or off, the "powered by" footer, logo and favicon (an https URL, or an image uploaded with create_upload), color, header links, typeface, the sender name and reply-to of customer emails, and a custom portal domain (returns the DNS records to create; check_custom_domain checks them). Only fields you pass change; null clears. Owners only.
Toolset
admin
Who can call it
Owners
REST
PATCH /api/v1/w/{workspace}/settings
Behavior
changes dataidempotent
Input
Field
Type
Description
name
string
The workspace's name.
roadmap_enabled
boolean
changelog_enabled
boolean
show_powered_by
boolean
The "Feedback by CareChannel" footer.
logo_url
string (uri) or null
favicon_url
string (uri) or null
logo_upload
string or null
An image uploaded with create_upload (png, jpeg, webp or gif, at most 2 MB) to use as the logo instead of logo_url; null removes it.
favicon_upload
string or null
An uploaded image to use as the favicon instead of favicon_url; null removes it.
primary_color
string or null
Buttons and links, e.g. "#4f46e5".
header_links
array of object
Links in the portal header, at most 5; [] removes them.
typeface
one of: inter, humanist, serif
The portal's typeface: inter, humanist (a softer sans) or serif.
email_from_name
string or null
The sender name on customer emails; null uses CareChannel's default.
email_reply_to
string (email) or null
Where customers' replies go; null for no reply-to.
custom_domain
string or null
A domain like feedback.example.com for the portal; null removes it.
expected_version
integer
Output
Field
Type
Description
namerequired
string
The workspace's name, shown on the portal and in emails.
portal_settingsrequired
object
brandingrequired
object
emailrequired
object
How customer emails are sent: sender name and reply-to.