WorkspaceSettingsDto

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clarifymedical/main/json-schema/clarifymedical-workspace-settings-dto-schema.json",
  "title": "WorkspaceSettingsDto",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/clarifymedical-openapi.json#/components/schemas/WorkspaceSettingsDto",
  "type": "object",
  "properties": {
    "orgDescription": {
      "type": "string",
      "description": "Free-text description of the organization, used to ground AI features."
    },
    "ingestionRules": {
      "type": "object",
      "properties": {
        "action": {
          "type": "string",
          "enum": [
            "allow",
            "block"
          ],
          "description": "Whether matching items are allowed (everything else blocked) or blocked (everything else allowed)."
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "email_address"
                ],
                "description": "The field the rule matches against."
              },
              "value": {
                "oneOf": [
                  {
                    "oneOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "object",
                        "properties": {
                          "regex": {
                            "type": "string",
                            "description": "A regular expression to match against."
                          }
                        },
                        "required": [
                          "regex"
                        ]
                      }
                    ]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "pattern": {
                        "type": "string",
                        "description": "A glob-style pattern to match against."
                      }
                    },
                    "required": [
                      "pattern"
                    ]
                  }
                ],
                "description": "The value to match: an exact string, a `regex` object, or a `pattern` object."
              }
            },
            "required": [
              "type",
              "value"
            ]
          },
          "description": "The rules to match against."
        }
      },
      "required": [
        "action",
        "items"
      ],
      "description": "Allow/block rules for email and calendar ingestion. When an allow list is provided, the block list is ignored. In a block list, a bare domain such as `company.com` or `@company.com` is stored as the address pattern `*@company.com`, so it matches every address at that domain."
    },
    "ingestionRecordCreation": {
      "type": "string",
      "enum": [
        "disabled",
        "selective",
        "always"
      ],
      "description": "Default record-creation behavior for email/calendar ingestion."
    },
    "excludeInternalIngestion": {
      "type": "string",
      "enum": [
        "none",
        "emails",
        "meetings",
        "all"
      ],
      "description": "Whether internal (same-domain) emails and meetings are excluded from ingestion."
    },
    "enablePrivateMeetingIngestion": {
      "type": "boolean",
      "description": "Whether private meetings are ingested."
    },
    "enableZeroParticipantMeetingIngestion": {
      "type": "boolean",
      "description": "Whether meetings with no participants are ingested."
    },
    "enableAttachmentIngestion": {
      "type": "boolean",
      "description": "Whether email attachments are ingested onto records."
    },
    "dealSummaryEnabled": {
      "default": true,
      "type": "boolean",
      "description": "Whether AI deal summaries are generated."
    },
    "dealSummaryPrompt": {
      "type": "array",
      "items": {},
      "description": "Custom rich-text prompt used when generating deal summaries."
    },
    "dealDetectionEnabled": {
      "type": "boolean",
      "description": "Whether AI deal detection runs. Defaults to enabled."
    },
    "dealDetectionPrompt": {
      "type": "string",
      "description": "Custom prompt used by AI deal detection."
    },
    "dealFieldUpdatesEnabled": {
      "type": "boolean",
      "description": "Whether AI updates deal fields automatically. Defaults to enabled."
    },
    "meetingRecordingScope": {
      "default": "none",
      "type": "string",
      "enum": [
        "all",
        "externalOnly",
        "none"
      ],
      "description": "Which meetings the recorder joins by default."
    },
    "meetingDefaultVisibility": {
      "default": "private",
      "type": "string",
      "enum": [
        "workspace",
        "private"
      ],
      "description": "Who sees a newly synced meeting: `workspace` seeds a workspace grant on it, `private` leaves it to its participants."
    },
    "messageDefaultVisibility": {
      "default": "private",
      "type": "string",
      "enum": [
        "workspace",
        "private"
      ],
      "description": "Who sees a newly synced email: `workspace` seeds a workspace grant on it, `private` leaves it to its mailbox owner and recipients."
    },
    "lockMeetingRecordingScope": {
      "default": false,
      "type": "boolean",
      "description": "When on, the workspace meeting recording scope applies to all members and per-user overrides are ignored."
    },
    "meetingPrepScope": {
      "default": "all",
      "type": "string",
      "enum": [
        "all",
        "none"
      ],
      "description": "Which meetings get AI meeting prep."
    },
    "publishMeetingPrepToCalendar": {
      "type": "boolean",
      "description": "Whether meeting prep notes are published to the calendar event."
    },
    "meetingSummaryEnabled": {
      "default": true,
      "type": "boolean",
      "description": "Whether AI meeting summaries are generated."
    },
    "externalMeetingSummaryEnabled": {
      "default": false,
      "type": "boolean",
      "description": "Whether meeting summaries are generated for external meetings."
    },
    "meetingTemplates": {
      "default": {
        "default": {
          "summaryTemplate": {
            "instructions": "Summarize what was discussed in the meeting. Keep it concise, factual, and neutral. Capture key points, decisions, blockers, and next steps. Include direct quotes only when they add clarity or context.\n\nUse well formatted bullet points under the section headers. ASCII only. Each line = new bullet.",
            "sections": [
              {
                "title": "Overview",
                "content": "Two sentences to three sentences summarizing what happened with minimal formatting."
              },
              {
                "title": "Participants + Context",
                "content": "* Who attended\n* Purpose of the meeting\n* Relevant background or prior context"
              },
              {
                "title": "Key Discussion Points",
                "content": "* Main topics covered\n* Important details shared\n* Notable quotes (optional)"
              },
              {
                "title": "Decisions Made",
                "content": "* Agreements, approvals, or resolved items\n* Ownership for each decision"
              },
              {
                "title": "Open Questions / Issues",
                "content": "* Items needing clarification\n* Risks, blockers, or concerns raised"
              },
              {
                "title": "Action Items & Next Steps",
                "content": "* Tasks, owners, and deadlines\n* Follow-ups required\n* Dependencies or required inputs"
              },
              {
                "title": "Rapport",
                "content": "* Rapport details - anything personal about who they are, what they like, where they are, etc."
              }
            ]
          }
        },
        "types": {
          "U0FMRVNESVNDT1ZFUlk": {
            "summaryTemplate": {
              "instructions": "Keep each section concise and actionable. Prioritize: pains, workflow gaps, buying triggers, and next steps. Pull in exact quotes where useful. Highlight any numbers, tools, timelines, or commitments they mention. Focus on information that advances qualification, forecasting, or the close.\n\nWrite bullet points in each section. Keep bullets brief with no filler words. Be concise.",
              "sections": [
                {
                  "title": "Summary",
                  "content": "Two sentences to three sentences summarizing what happened with minimal formatting."
                },
                {
                  "title": "Company + Buyer Context",
                  "content": "* Company overview (industry, size, GTM motion)\n* Buyer role, responsibilities, KPIs\n* Key quotes (their words)"
                },
                {
                  "title": "Pain + Use Cases",
                  "content": "* Primary pains\n* Current workflow + what's breaking\n* Desired outcomes\n* Specific use cases they emphasized"
                },
                {
                  "title": "GTM Tech Stack",
                  "content": "* Current CRM + core tooling\n* Supplementary tools (enrichment, dialer, sequences, reporting, notes)\n* What they like / dislike\n* Identified gaps"
                },
                {
                  "title": "Competition / Alternatives",
                  "content": "* Tools they're evaluating\n* Tools they're replacing\n* Status quo option (keep doing nothing)\n* Must-haves vs nice-to-haves"
                },
                {
                  "title": "Product Feedback / Questions",
                  "content": "* Product requests they made\n* Confusions or unclear parts of the product\n* Areas they pushed on (AI behavior, accuracy, reporting, workflows, credits, integrations)\n* Key questions that signal buying criteria"
                },
                {
                  "title": "BANT",
                  "content": "* Budget: Amount, flexibility\n* Authority: Decision maker + influencers\n* Need: Severity + urgency\n* Timeline: Renewals, deadlines, internal constraints"
                },
                {
                  "title": "Misc.",
                  "content": "* What else was discussed that is important to capture?"
                },
                {
                  "title": "Next Steps",
                  "content": "* Action items\n* Owners (you/them)\n* Dates + commitments\n* Dependencies (data export, stakeholder loop-in, trial setup)"
                }
              ]
            }
          },
          "U0FMRVNDTE9TSU5H": {
            "summaryTemplate": {
              "instructions": "Focus on commercial signals, decision details, risks, and what is required to close. Capture exact numbers, terms, blockers, and commitments.\n\nWrite bullet points in each section. Keep bullets brief with no filler words. Be concise.",
              "sections": [
                {
                  "title": "Summary (TL;DR)",
                  "content": "* Where they stand in decision process\n* Remaining blockers (their words)\n* Final requirements to close\n* Commercial details they confirmed\n* The one next step that moves the deal to signature"
                },
                {
                  "title": "Decision Process",
                  "content": "* Where they are in the decision\n* Who signs + remaining approvals\n* Key quotes"
                },
                {
                  "title": "Commercials",
                  "content": "* Plan / pricing\n* Contract length\n* Budget alignment"
                },
                {
                  "title": "Open Questions / Blockers",
                  "content": "* Concerns\n* Requirements\n* Competitive pressure"
                },
                {
                  "title": "Next Steps",
                  "content": "* Actions\n* Owners\n* Deadlines"
                }
              ]
            }
          },
          "Q1NPTkJPQVJESU5H": {
            "summaryTemplate": {
              "instructions": "Focus on highlighting the most important and specific needs identified.\n\nWrite bullet points in each section. Keep bullets brief with no filler words. Be concise.",
              "sections": [
                {
                  "title": "Goals & Success Criteria",
                  "content": "* Goals for the implementation (cost savings, specific features, consolidation, etc.)\n* Agreed upon success metrics and key milestones\n* Timeline expectations and any hard deadlines\n* Team members involved and their roles"
                },
                {
                  "title": "Current State & Migration",
                  "content": "* What tools or processes they're migrating from\n* Features and workflows that must be replicated\n* Data and integrations to be brought over"
                },
                {
                  "title": "Configuration & Setup",
                  "content": "* Key workflows and processes to configure\n* User roles and access requirements\n* Reporting and dashboard needs"
                },
                {
                  "title": "Training & Adoption",
                  "content": "* Training requirements and format preferences\n* Key users who need onboarding\n* Documentation or resources needed"
                },
                {
                  "title": "Next Steps",
                  "content": "* Action items\n* Owners (you/them)\n* Deadlines"
                }
              ]
            }
          },
          "Q1NBQ0NPVU5UUkVWSUVX": {
            "summaryTemplate": {
              "instructions": "Capture the customer's perspective and account health signals. Focus on usage patterns, satisfaction, expansion opportunities, and renewal risks. Use exact quotes where relevant. Be concise and actionable.\n\nWrite bullet points in each section. Keep bullets brief with no filler words. Be concise.",
              "sections": [
                {
                  "title": "Summary",
                  "content": "* Overall account health and sentiment\n* Key takeaway from the meeting"
                },
                {
                  "title": "Usage & Adoption",
                  "content": "* How they're using the product (features, workflows, frequency)\n* Team adoption and engagement levels\n* Key metrics or outcomes they've achieved"
                },
                {
                  "title": "Feedback & Concerns",
                  "content": "* Feature requests or product feedback\n* Concerns or pain points mentioned\n* Key quotes (their words)"
                },
                {
                  "title": "Expansion Opportunities",
                  "content": "* Additional use cases or teams that could benefit\n* Features they're interested in but not using\n* Upsell or cross-sell signals"
                },
                {
                  "title": "Renewal & Risk",
                  "content": "* Renewal timeline and considerations\n* Churn risk signals\n* Competitive pressure or alternatives mentioned"
                },
                {
                  "title": "Next Steps",
                  "content": "* Follow-up actions\n* Owners (you/them)\n* Deadlines or commitments"
                }
              ]
            }
          },
          "Q1NTVVBQT1JU": {
            "summaryTemplate": {
              "instructions": "Document the issue clearly and concisely. Focus on what happened, resolution steps, and prevention. Capture exact error messages, steps to reproduce, and customer impact. Be specific and actionable.\n\nWrite bullet points in each section. Keep bullets brief with no filler words. Be concise.",
              "sections": [
                {
                  "title": "Summary",
                  "content": "* What the issue is\n* Current resolution status"
                },
                {
                  "title": "Issue Details",
                  "content": "* What the customer reported (their exact words)\n* Steps to reproduce (if applicable)\n* Error messages or symptoms observed\n* When it started and frequency"
                },
                {
                  "title": "Root Cause & Resolution",
                  "content": "* What caused the issue\n* Steps taken to resolve\n* Workaround provided (if any)\n* Permanent fix status"
                },
                {
                  "title": "Impact",
                  "content": "* How this affected the customer\n* Number of users affected\n* Business impact or urgency level"
                },
                {
                  "title": "Next Steps",
                  "content": "* Action items to fully resolve\n* Owners\n* Deadlines\n* Prevention measures"
                }
              ]
            }
          }
        }
      },
      "type": "object",
      "properties": {
        "default": {
          "type": "object",
          "properties": {
            "summaryTemplate": {
              "type": "object",
              "properties": {
                "instructions": {
                  "type": "string",
                  "maxLength": 500,
                  "description": "Overall instructions for generating the summary."
                },
                "sections": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "title": {
                        "type": "string",
                        "maxLength": 100,
                        "description": "The section heading."
                      },
                      "content": {
                        "type": "string",
                        "maxLength": 500,
                        "description": "Guidance on what the section should contain."
                      }
                    },
                    "required": [
                      "title",
                      "content"
                    ]
                  },
                  "maxItems": 50,
                  "description": "The sections the summary is organized into."
                }
              },
              "required": [
                "instructions",
                "sections"
              ],
              "description": "The template used when generating meeting summaries."
            }
          },
          "required": [
            "summaryTemplate"
          ],
          "description": "The template used for meeting types without their own entry in `types`."
        },
        "types": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {
              "summaryTemplate": {
                "type": "object",
                "properties": {
                  "instructions": {
                    "type": "string",
                    "maxLength": 500,
                    "description": "Overall instructions for generating the summary."
                  },
                  "sections": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "title": {
                          "type": "string",
                          "maxLength": 100,
                          "description": "The section heading."
                        },
                        "content": {
                          "type": "string",
                          "maxLength": 500,
                          "description": "Guidance on what the section should contain."
                        }
                      },
                      "required": [
                        "title",
                        "content"
                      ]
                    },
                    "maxItems": 50,
                    "description": "The sections the summary is organized into."
                  }
                },
                "required": [
                  "instructions",
                  "sections"
                ],
                "description": "The template used when generating meeting summaries."
              }
            },
            "required": [
              "summaryTemplate"
            ]
          },
          "description": "Per-meeting-type template overrides, keyed by meeting type ID."
        }
      },
      "required": [
        "default",
        "types"
      ],
      "description": "Meeting summary templates configured for the workspace."
    },
    "meetingTaskScope": {
      "default": "external",
      "type": "string",
      "enum": [
        "all",
        "external",
        "none"
      ],
      "description": "Which meetings produce AI-suggested tasks."
    },
    "companyEmailDomains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The workspace’s own email domains, used to tell internal from external contacts."
    },
    "meetingRecorderName": {
      "type": "string",
      "maxLength": 50,
      "description": "Display name the meeting recorder bot joins calls with."
    },
    "enableRecorderBackground": {
      "type": "boolean",
      "description": "Whether the recorder bot shows a custom background image."
    },
    "meetingRecorderBackground": {
      "type": "string",
      "description": "URL of the recorder bot’s custom background image."
    },
    "meetingVideoStorageDisabled": {
      "type": "boolean",
      "description": "When enabled, meeting video recordings are not stored — transcript-only mode."
    },
    "closedWonDealStage": {
      "type": "string",
      "description": "The deal stage that counts as closed-won in reporting."
    },
    "closedLostDealStage": {
      "type": "string",
      "description": "The deal stage that counts as closed-lost in reporting."
    },
    "fiscalYearOffset": {
      "type": "number",
      "description": "Offset in months between the fiscal year and the calendar year, used in reporting."
    },
    "billingOveragesDisabled": {
      "default": true,
      "type": "boolean",
      "description": "Whether on-demand (overage) credit spending is disabled. Defaults to disabled; set to `false` to opt in."
    },
    "billingOverageSpendLimitDollars": {
      "type": "integer",
      "minimum": 1,
      "description": "Per-billing-period cap on on-demand (overage) spend, in whole dollars. Once reached, credit consumption is blocked. Unset means unlimited overages."
    },
    "billingSeatSpendLimitsEnabled": {
      "default": false,
      "type": "boolean",
      "description": "Whether per-seat spend limits are enabled for the workspace. Defaults to off; when off no per-seat caps are enforced and the config UI is hidden."
    },
    "billingSeatSpendLimitCredits": {
      "type": "integer",
      "minimum": 0,
      "description": "Monthly cap on how many credits each member can consume, resetting on the billing day even on annual plans. `0` blocks all spend; unset means no per-seat limit."
    },
    "billingSeatSpendLimitCreditsUserOverrides": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "minimum": 0
      },
      "description": "Per-user overrides of the seat spend cap, keyed by user id (credits; `0` blocks the member). Members without an entry use the workspace default."
    },
    "billingUseLegacyPricing": {
      "type": "boolean",
      "description": "Hidden setting keeping a workspace on legacy (V1) pricing after new pricing is enabled globally."
    },
    "historicalSyncPeriodDays": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9125,
      "description": "How many days of email/calendar history are synced when connecting an account."
    },
    "emailLocalParts": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Senders excluded from record creation. Each entry is a local part (`noreply`), a full address, an exact domain (`@assistant.gong.io`), or a wildcard pattern (`*@*.vendor.com` to also cover subdomains). Matching emails and meetings are still captured."
    },
    "emailBrandingFooter": {
      "type": "boolean",
      "description": "Whether outbound emails include the Clarify branding footer."
    },
    "advancedEnrichmentsOverride": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "description": "Admin override of the advanced-enrichment quota. `0` disables; unset uses the plan default."
    },
    "maxActiveCampaignsOverride": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9999,
      "description": "Admin override of the maximum number of active campaigns. Unset uses the plan default."
    },
    "maxCustomObjectsOverride": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9999,
      "description": "Admin override of the maximum number of custom objects. Unset uses the plan default."
    },
    "maxConnectedAccountsOverride": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9999,
      "description": "Admin override of the maximum number of connected accounts. Unset uses the plan default."
    },
    "reverseTrialEndOverride": {
      "type": "string",
      "format": "date-time",
      "description": "Admin override of the reverse-trial end date (ISO 8601). When set, the trial expires at this instant instead of the default period."
    },
    "freeWorkspaceCreditLimitOverride": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000000,
      "description": "Admin override of the credit allowance for workspaces without a paid subscription. Replaces the plan-default included credits."
    },
    "reverseTrialBonusMemberIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 10000,
      "description": "Users who joined during the reverse trial. Each adds member-bonus credits while the trial is active."
    }
  }
}