Docs: Tool reference
admin toolset

update_workspace_settings

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

FieldTypeDescription
namestringThe workspace's name.
roadmap_enabledboolean
changelog_enabledboolean
show_powered_bybooleanThe "Feedback by CareChannel" footer.
logo_urlstring (uri) or null
favicon_urlstring (uri) or null
logo_uploadstring or nullAn 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_uploadstring or nullAn uploaded image to use as the favicon instead of favicon_url; null removes it.
primary_colorstring or nullButtons and links, e.g. "#4f46e5".
header_linksarray of objectLinks in the portal header, at most 5; [] removes them.
typefaceone of: inter, humanist, serifThe portal's typeface: inter, humanist (a softer sans) or serif.
email_from_namestring or nullThe sender name on customer emails; null uses CareChannel's default.
email_reply_tostring (email) or nullWhere customers' replies go; null for no reply-to.
custom_domainstring or nullA domain like feedback.example.com for the portal; null removes it.
expected_versioninteger

Output

FieldTypeDescription
namerequiredstringThe workspace's name, shown on the portal and in emails.
portal_settingsrequiredobject
brandingrequiredobject
emailrequiredobjectHow customer emails are sent: sender name and reply-to.
custom_domainrequiredobject or null
portal_urlrequiredstring (uri)
versionrequiredinteger

Calling it

// MCP: tools/call
{ "name": "update_workspace_settings", "arguments": {} }

// Typed client
await carechannel.update_workspace_settings({});