manage_workspace_settings
Update organization settings or AI-label settings for a workspace; the action selects which settings document is patched.
# MCP tool reference
1 callable tools.
Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.
Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.
[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)
## manage_workspace_settings
Update organization settings or AI-label settings for a workspace; the action selects which settings document is patched.
Use to change workspace behaviour after read_workspace_settings shows the current values.
Patch payloads must carry at least one field; empty patches are rejected rather than no-oped.
Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token.
Scopes: workspace:update
Risk: write; confirmation: explicit; idempotency: supported.
### Input schema (personal API key)
```json
{
"type": "object",
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"anyOf": [
{
"type": "string",
"enum": [
"update_workspace_settings"
]
}
]
},
"patch": {
"type": "object",
"properties": {
"contactSuggestionsAutoConfirm": {
"type": "boolean"
},
"autoReminderEnabled": {
"type": "boolean"
},
"autoReminderDays": {
"type": "integer",
"minimum": 1,
"maximum": 365
},
"autoReminderBusinessDaysOnly": {
"type": "boolean"
},
"dailyCapPerRecipientDomain": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"textMessageSenderNumber": {
"anyOf": [
{
"$ref": "#/$defs/E164PhoneNumber"
},
{
"type": "null"
}
]
}
},
"patternProperties": {
"^(?!(?:contactSuggestionsAutoConfirm|autoReminderEnabled|autoReminderDays|autoReminderBusinessDaysOnly|dailyCapPerRecipientDomain|textMessageSenderNumber)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"contactSuggestionsAutoConfirm",
"autoReminderEnabled",
"autoReminderDays",
"autoReminderBusinessDaysOnly",
"dailyCapPerRecipientDomain",
"textMessageSenderNumber"
]
},
"minProperties": 1,
"maxProperties": 6
}
},
"required": [
"workspaceId",
"action",
"patch"
],
"patternProperties": {
"^(?!(?:workspaceId|action|patch)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"patch"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"anyOf": [
{
"type": "string",
"enum": [
"update_ai_label_settings"
]
}
]
},
"patch": {
"type": "object",
"properties": {
"aiLabelDetection": {
"type": "boolean"
},
"labelCategorizationPrompt": {
"type": "string",
"maxLength": 2000
},
"emailNotificationForPositiveReplies": {
"type": "boolean"
},
"emailNotificationForAiFollowUpApprovals": {
"type": "boolean"
},
"notificationEmails": {
"type": "array",
"items": {
"$ref": "#/$defs/EmailAddress"
},
"maxItems": 100
}
},
"patternProperties": {
"^(?!(?:aiLabelDetection|labelCategorizationPrompt|emailNotificationForPositiveReplies|emailNotificationForAiFollowUpApprovals|notificationEmails)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"aiLabelDetection",
"labelCategorizationPrompt",
"emailNotificationForPositiveReplies",
"emailNotificationForAiFollowUpApprovals",
"notificationEmails"
]
},
"minProperties": 1,
"maxProperties": 5
}
},
"required": [
"workspaceId",
"action",
"patch"
],
"patternProperties": {
"^(?!(?:workspaceId|action|patch)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"patch"
]
}
}
],
"$defs": {
"E164PhoneNumber": {
"type": "string",
"pattern": "^\\+[1-9]\\d{1,14}$"
},
"EmailAddress": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Target Workspace UUID. Call list_workspaces to enumerate the Workspaces this credential may access, then pass the chosen id here."
}
},
"required": [
"workspaceId"
],
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"anyOf": [
{
"type": "string",
"enum": [
"update_workspace_settings"
]
}
]
},
"patch": {
"type": "object",
"properties": {
"contactSuggestionsAutoConfirm": {
"type": "boolean"
},
"autoReminderEnabled": {
"type": "boolean"
},
"autoReminderDays": {
"type": "integer",
"minimum": 1,
"maximum": 365
},
"autoReminderBusinessDaysOnly": {
"type": "boolean"
},
"dailyCapPerRecipientDomain": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"textMessageSenderNumber": {
"anyOf": [
{
"$ref": "#/$defs/E164PhoneNumber"
},
{
"type": "null"
}
]
}
},
"patternProperties": {
"^(?!(?:contactSuggestionsAutoConfirm|autoReminderEnabled|autoReminderDays|autoReminderBusinessDaysOnly|dailyCapPerRecipientDomain|textMessageSenderNumber)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"contactSuggestionsAutoConfirm",
"autoReminderEnabled",
"autoReminderDays",
"autoReminderBusinessDaysOnly",
"dailyCapPerRecipientDomain",
"textMessageSenderNumber"
]
},
"minProperties": 1,
"maxProperties": 6
}
},
"required": [
"workspaceId",
"action",
"patch"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|patch)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"patch"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"anyOf": [
{
"type": "string",
"enum": [
"update_ai_label_settings"
]
}
]
},
"patch": {
"type": "object",
"properties": {
"aiLabelDetection": {
"type": "boolean"
},
"labelCategorizationPrompt": {
"type": "string",
"maxLength": 2000
},
"emailNotificationForPositiveReplies": {
"type": "boolean"
},
"emailNotificationForAiFollowUpApprovals": {
"type": "boolean"
},
"notificationEmails": {
"type": "array",
"items": {
"$ref": "#/$defs/EmailAddress"
},
"maxItems": 100
}
},
"patternProperties": {
"^(?!(?:aiLabelDetection|labelCategorizationPrompt|emailNotificationForPositiveReplies|emailNotificationForAiFollowUpApprovals|notificationEmails)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"aiLabelDetection",
"labelCategorizationPrompt",
"emailNotificationForPositiveReplies",
"emailNotificationForAiFollowUpApprovals",
"notificationEmails"
]
},
"minProperties": 1,
"maxProperties": 5
}
},
"required": [
"workspaceId",
"action",
"patch"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|patch)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"patch"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
}
],
"$defs": {
"E164PhoneNumber": {
"type": "string",
"pattern": "^\\+[1-9]\\d{1,14}$"
},
"EmailAddress": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"Description": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"IanaTimeZone": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$"
},
"E164PhoneNumber": {
"type": "string",
"pattern": "^\\+[1-9]\\d{1,14}$"
},
"EmailAddress": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"contactSuggestionsAutoConfirm": {
"type": "boolean"
},
"contactSuggestionsAutoConfirmSince": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"replyDetectionAiPrompt": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
]
},
"googleEspMatch": {
"type": "string",
"enum": [
"google",
"microsoft",
"other",
"all",
"tags",
"skip"
]
},
"microsoftEspMatch": {
"type": "string",
"enum": [
"google",
"microsoft",
"other",
"all",
"tags",
"skip"
]
},
"otherEspMatch": {
"type": "string",
"enum": [
"google",
"microsoft",
"other",
"all",
"tags",
"skip"
]
},
"timezone": {
"$ref": "#/$defs/IanaTimeZone"
},
"dailySendingLimit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"textMessageSenderNumber": {
"anyOf": [
{
"$ref": "#/$defs/E164PhoneNumber"
},
{
"type": "null"
}
]
},
"dailyCapPerRecipientDomain": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"autoReminderEnabled": {
"type": "boolean"
},
"autoReminderDays": {
"type": "integer",
"minimum": 1,
"maximum": 365
},
"autoReminderBusinessDaysOnly": {
"type": "boolean"
},
"verificationSharingMode": {
"type": "string",
"enum": [
"contribute_and_consume",
"consume_only",
"private"
]
},
"createdAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"updatedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"workspaceId",
"contactSuggestionsAutoConfirm",
"contactSuggestionsAutoConfirmSince",
"replyDetectionAiPrompt",
"googleEspMatch",
"microsoftEspMatch",
"otherEspMatch",
"timezone",
"dailySendingLimit",
"textMessageSenderNumber",
"dailyCapPerRecipientDomain",
"autoReminderEnabled",
"autoReminderDays",
"autoReminderBusinessDaysOnly",
"verificationSharingMode",
"createdAt",
"updatedAt"
],
"patternProperties": {
"^(?!(?:workspaceId|contactSuggestionsAutoConfirm|contactSuggestionsAutoConfirmSince|replyDetectionAiPrompt|googleEspMatch|microsoftEspMatch|otherEspMatch|timezone|dailySendingLimit|textMessageSenderNumber|dailyCapPerRecipientDomain|autoReminderEnabled|autoReminderDays|autoReminderBusinessDaysOnly|verificationSharingMode|createdAt|updatedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"contactSuggestionsAutoConfirm",
"contactSuggestionsAutoConfirmSince",
"replyDetectionAiPrompt",
"googleEspMatch",
"microsoftEspMatch",
"otherEspMatch",
"timezone",
"dailySendingLimit",
"textMessageSenderNumber",
"dailyCapPerRecipientDomain",
"autoReminderEnabled",
"autoReminderDays",
"autoReminderBusinessDaysOnly",
"verificationSharingMode",
"createdAt",
"updatedAt"
]
}
},
{
"type": "object",
"properties": {
"aiLabelDetection": {
"type": "boolean"
},
"labelCategorizationPrompt": {
"type": "string",
"maxLength": 2000
},
"emailNotificationForPositiveReplies": {
"type": "boolean"
},
"emailNotificationForAiFollowUpApprovals": {
"type": "boolean"
},
"notificationEmails": {
"type": "array",
"items": {
"$ref": "#/$defs/EmailAddress"
},
"maxItems": 100
}
},
"required": [
"aiLabelDetection",
"labelCategorizationPrompt",
"emailNotificationForPositiveReplies",
"emailNotificationForAiFollowUpApprovals",
"notificationEmails"
],
"patternProperties": {
"^(?!(?:aiLabelDetection|labelCategorizationPrompt|emailNotificationForPositiveReplies|emailNotificationForAiFollowUpApprovals|notificationEmails)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"aiLabelDetection",
"labelCategorizationPrompt",
"emailNotificationForPositiveReplies",
"emailNotificationForAiFollowUpApprovals",
"notificationEmails"
]
}
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"contactSuggestionsAutoConfirm": {
"type": "boolean"
},
"contactSuggestionsAutoConfirmSince": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"replyDetectionAiPrompt": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
]
},
"googleEspMatch": {
"type": "string",
"enum": [
"google",
"microsoft",
"other",
"all",
"tags",
"skip"
]
},
"microsoftEspMatch": {
"type": "string",
"enum": [
"google",
"microsoft",
"other",
"all",
"tags",
"skip"
]
},
"otherEspMatch": {
"type": "string",
"enum": [
"google",
"microsoft",
"other",
"all",
"tags",
"skip"
]
},
"timezone": {
"$ref": "#/$defs/IanaTimeZone"
},
"dailySendingLimit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"textMessageSenderNumber": {
"anyOf": [
{
"$ref": "#/$defs/E164PhoneNumber"
},
{
"type": "null"
}
]
},
"dailyCapPerRecipientDomain": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"autoReminderEnabled": {
"type": "boolean"
},
"autoReminderDays": {
"type": "integer",
"minimum": 1,
"maximum": 365
},
"autoReminderBusinessDaysOnly": {
"type": "boolean"
},
"verificationSharingMode": {
"type": "string",
"enum": [
"contribute_and_consume",
"consume_only",
"private"
]
},
"createdAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"updatedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"workspaceId",
"contactSuggestionsAutoConfirm",
"contactSuggestionsAutoConfirmSince",
"replyDetectionAiPrompt",
"googleEspMatch",
"microsoftEspMatch",
"otherEspMatch",
"timezone",
"dailySendingLimit",
"textMessageSenderNumber",
"dailyCapPerRecipientDomain",
"autoReminderEnabled",
"autoReminderDays",
"autoReminderBusinessDaysOnly",
"verificationSharingMode",
"createdAt",
"updatedAt"
],
"patternProperties": {
"^(?!(?:workspaceId|contactSuggestionsAutoConfirm|contactSuggestionsAutoConfirmSince|replyDetectionAiPrompt|googleEspMatch|microsoftEspMatch|otherEspMatch|timezone|dailySendingLimit|textMessageSenderNumber|dailyCapPerRecipientDomain|autoReminderEnabled|autoReminderDays|autoReminderBusinessDaysOnly|verificationSharingMode|createdAt|updatedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"contactSuggestionsAutoConfirm",
"contactSuggestionsAutoConfirmSince",
"replyDetectionAiPrompt",
"googleEspMatch",
"microsoftEspMatch",
"otherEspMatch",
"timezone",
"dailySendingLimit",
"textMessageSenderNumber",
"dailyCapPerRecipientDomain",
"autoReminderEnabled",
"autoReminderDays",
"autoReminderBusinessDaysOnly",
"verificationSharingMode",
"createdAt",
"updatedAt"
]
}
},
{
"type": "object",
"properties": {
"aiLabelDetection": {
"type": "boolean"
},
"labelCategorizationPrompt": {
"type": "string",
"maxLength": 2000
},
"emailNotificationForPositiveReplies": {
"type": "boolean"
},
"emailNotificationForAiFollowUpApprovals": {
"type": "boolean"
},
"notificationEmails": {
"type": "array",
"items": {
"$ref": "#/$defs/EmailAddress"
},
"maxItems": 100
}
},
"required": [
"aiLabelDetection",
"labelCategorizationPrompt",
"emailNotificationForPositiveReplies",
"emailNotificationForAiFollowUpApprovals",
"notificationEmails"
],
"patternProperties": {
"^(?!(?:aiLabelDetection|labelCategorizationPrompt|emailNotificationForPositiveReplies|emailNotificationForAiFollowUpApprovals|notificationEmails)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"aiLabelDetection",
"labelCategorizationPrompt",
"emailNotificationForPositiveReplies",
"emailNotificationForAiFollowUpApprovals",
"notificationEmails"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `workspaceSettings.update`: `PATCH /v1/workspaces/:workspaceId/settings`
- `aiLabels.update`: `PATCH /v1/workspaces/:workspaceId/settings/ai-labels`