Saasco logoSaasco logo
Saasco logoSaasco logo

Introduction

OverviewGetting startedAgent setupWhat is Saasco?

SDK

Quick startTrackingIdentifyConfigurationWidgetsProperties

MCP

Quick startHow it worksAuthorizationTool reference
Skills for agents

REST API

Quick start
getGet Support Widget SettingspatchUpdate Support Widget Settings
SupportWidget

Update Support Widget Settings

View as MarkdownAgent setup

Updates Support widget settings in one save and returns the complete settings payload. Omitted fields, including nested fields, stay unchanged. Trusted domains replace the current list; entries must be bare hostnames. A support mailbox domain must belong to this project and be ready to send and receive. Null mailbox.supportDomain clears it. Set any launcher field to null to remove its saved override and restore the default; omitted launcher fields stay unchanged. Does not change credentials or notification recipients.

PATCH
/projects/{projectId}/support/settings

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

projectIdrequiredstring

ID of the project whose Support settings to update.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

settingsrequiredobject

Partial settings to merge. Omitted fields stay unchanged.

emailAgentEnabledboolean
enabledboolean
widgetAgentEnabledboolean
emailBrandingobject
emailAvatarUrlstring
emailFooterstring
emailFromNamestring
emailHeaderNamestring
launcherobject

Partial launcher settings. Omit a field to preserve it; set it to null to remove its saved override and restore the default. For example, { customLauncherSelector: null, launcherSize: null } removes the custom selector and restores automatic sizing.

alignmentstring | null
customLauncherSelectorstring | null
hideDefaultLauncherboolean | null
horizontalPaddinginteger | null
launcherSizestring | null
verticalPaddinginteger | null
zIndexinteger | null
mailboxobject
supportDomainstring | null
supportLocalPartstring
officeHoursobject
officeHoursEnabledboolean
officeHoursScheduleobject
officeHoursTimezonestring
replyTimestring
trustedDomainsarray<string>
widgetBrandingobject
agentLabelstring
avatarUrlstring
Format: uri
greetingstring
suggestedQuestionsarray<string>
teamDescriptionstring
workspaceNamestring

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/projects/string/support/settings" \  -H "Content-Type: application/json" \  -d '{    "settings": {}  }'
{  "emailAgentEnabled": true,  "enabled": true,  "widgetAgentEnabled": true,  "emailBranding": {    "emailAvatarUrl": "string",    "emailFooter": "string",    "emailFromName": "string",    "emailHeaderName": "string"  },  "launcher": {    "alignment": "left",    "customLauncherSelector": "string",    "hideDefaultLauncher": true,    "horizontalPadding": 0,    "launcherSize": "compact",    "verticalPadding": 0,    "zIndex": 0  },  "mailbox": {    "supportDomain": "string",    "supportLocalPart": "string"  },  "officeHours": {    "officeHoursEnabled": false,    "officeHoursSchedule": {      "property1": {        "close": "string",        "open": "string"      },      "property2": {        "close": "string",        "open": "string"      }    },    "officeHoursTimezone": "string",    "replyTime": "string"  },  "trustedDomains": [    "string"  ],  "widgetBranding": {    "agentLabel": "string",    "avatarUrl": "http://example.com",    "greeting": "string",    "suggestedQuestions": [      "string"    ],    "teamDescription": "string",    "workspaceName": "string"  }}

Get Support Widget Settings

Returns Support widget settings in one payload: widget and AI-agent enabled flags, trusted domains, support mailbox, widget and email branding, launcher, and office hours. Credentials and notification recipients are managed separately in the dashboard.

List Conversations

Lists Support inbox conversations (chat and email) with a preview line and unread count, not the transcript. Filter by state; omitted `state` returns open conversations. `open` and `closed` exclude spam. `all` includes spam unless `includeSpam` is false. `spam` lists only quarantined threads.