> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sendora.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update workspace settings

> Changes any of the workspace's settings in one call. Send only what should change. Steps run in the order org, company_profile, ai_reply_paused, mailing_address, team_access; if one is refused the earlier ones stay applied. Requires write access and an owner or admin. This operation can change workspace data or trigger an external side effect; review the request before sending it and do not retry blindly after a timeout.



## OpenAPI

````yaml /openapi.json patch /api/v1/public/workspace-settings
openapi: 3.1.0
info:
  description: >-
    Customer-facing API for managing outreach, leads, conversations, voice
    agents, knowledge bases, analytics, and webhooks.
  title: Sendora Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.sendora.ai
security: []
tags:
  - description: Leads, lead lists, importing, enriching and finding new prospects.
    name: Leads
  - description: Build, run and measure outreach, and enroll leads.
    name: Campaigns
  - description: Read and send messages, and manage who must not be contacted.
    name: Conversations
  - description: >-
      Voice and chat agents, their tools, knowledge bases, voices and website
      widgets.
    name: Agents
  - description: >-
      Start calls, and manage phone numbers, SMS registration, sending accounts
      and email domains.
    name: Calls and numbers
  - description: Webhooks, jobs, analytics and the Copilot assistant.
    name: Platform
  - description: Manage client workspaces, plans and branding.
    name: Agency
paths:
  /api/v1/public/workspace-settings:
    patch:
      tags:
        - Platform
      summary: Update workspace settings
      description: >-
        Changes any of the workspace's settings in one call. Send only what
        should change. Steps run in the order org, company_profile,
        ai_reply_paused, mailing_address, team_access; if one is refused the
        earlier ones stay applied. Requires write access and an owner or admin.
        This operation can change workspace data or trigger an external side
        effect; review the request before sending it and do not retry blindly
        after a timeout.
      operationId: update_settings_api_v1_public_workspace_settings_patch
      parameters:
        - in: header
          name: X-API-Key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
        - in: header
          name: Authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettingsUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                title: >-
                  Response Update Settings Api V1 Public Workspace Settings
                  Patch
                type: object
          description: Successful Response
        '401':
          description: The X-API-Key header is missing, invalid, expired, or revoked.
        '402':
          description: >-
            The workspace is suspended for billing, or the request would exceed
            a plan or usage limit.
        '403':
          description: >-
            The key is valid but lacks the required scope, or the workspace has
            no active plan, lacks the entitlement, or has this feature turned
            off or view-only.
        '410':
          description: The workspace behind this key has been deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '500':
          description: >-
            An unexpected Sendora error occurred. Retry only if the operation is
            safe to repeat.
        '503':
          description: >-
            An entitlement or billing check is temporarily unavailable. Retry
            after the Retry-After interval.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - label: cURL
          lang: bash
          source: >-
            curl -X PATCH
            'https://api.sendora.ai/api/v1/public/workspace-settings' -H
            "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
              -d '{"org":{"name":"example","timezone":"example","dashboard_cover":"example"},"company_profile":{"name":"example","description":"example","summary":"example"},"ai_reply_paused":true}'
        - label: Python
          lang: python
          source: >-
            import requests


            url = 'https://api.sendora.ai/api/v1/public/workspace-settings'

            headers = {'X-API-Key': '$SENDORA_API_KEY'}

            response = requests.patch(url, headers=headers, json={'org':
            {'name': 'example', 'timezone': 'example', 'dashboard_cover':
            'example'}, 'company_profile': {'name': 'example', 'description':
            'example', 'summary': 'example'}, 'ai_reply_paused': True})

            response.raise_for_status()

            print(response.json())
        - label: JavaScript
          lang: javascript
          source: >-
            const response = await
            fetch("https://api.sendora.ai/api/v1/public/workspace-settings", {
              method: "PATCH",
              headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
              body: JSON.stringify({"org": {"name": "example", "timezone": "example", "dashboard_cover": "example"}, "company_profile": {"name": "example", "description": "example", "summary": "example"}, "ai_reply_paused": true}),
            });

            if (!response.ok) throw new Error(await response.text());

            console.log(await response.json());
        - label: Go
          lang: go
          source: >-
            req, err := http.NewRequest("PATCH",
            "https://api.sendora.ai/api/v1/public/workspace-settings",
            bytes.NewBufferString(`{"org": {"name": "example", "timezone":
            "example", "dashboard_cover": "example"}, "company_profile":
            {"name": "example", "description": "example", "summary": "example"},
            "ai_reply_paused": true}`))

            if err != nil { log.Fatal(err) }

            req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))

            req.Header.Set("Content-Type", "application/json")

            resp, err := http.DefaultClient.Do(req)

            if err != nil { log.Fatal(err) }

            defer resp.Body.Close()
components:
  schemas:
    SettingsUpdate:
      properties:
        ai_reply_paused:
          anyOf:
            - type: boolean
            - type: 'null'
          description: true stops every AI reply in the workspace; false resumes them
          title: Ai Reply Paused
        company_profile:
          anyOf:
            - $ref: '#/components/schemas/CompanyProfileUpdate'
            - type: 'null'
          description: >-
            What the company does, who it sells to: used to write better
            outreach
        mailing_address:
          anyOf:
            - maxLength: 300
              minLength: 10
              type: string
            - type: 'null'
          description: Postal address shown in email footers
          title: Mailing Address
        org:
          anyOf:
            - $ref: '#/components/schemas/OrgSettingsUpdate'
            - type: 'null'
          description: >-
            Workspace name, timezone, dashboard cover, default permissions for
            new clients, Copilot name
        team_access:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/AccessUpdate'
              type: object
            - type: 'null'
          description: >-
            Set members' roles, extra grants or denials and limits: {member
            `id`: {role, grants, scopes}}. Owners and admins only
          title: Team Access
      required: []
      title: SettingsUpdate
      type: object
    HTTPValidationError:
      properties:
        detail:
          description: Detail returned by the Sendora API.
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      required: []
      title: HTTPValidationError
      type: object
    CompanyProfileUpdate:
      properties:
        description:
          anyOf:
            - maxLength: 4000
              type: string
            - type: 'null'
          description: Description returned by the Sendora API.
          title: Description
        hq:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          description: Hq returned by the Sendora API.
          title: Hq
        industry:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          description: Industry returned by the Sendora API.
          title: Industry
        name:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          description: Name returned by the Sendora API.
          title: Name
        sells_to:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Sells to returned by the Sendora API.
          title: Sells To
        summary:
          anyOf:
            - maxLength: 1000
              type: string
            - type: 'null'
          description: Summary returned by the Sendora API.
          title: Summary
        team_size:
          anyOf:
            - maxLength: 100
              type: string
            - type: 'null'
          description: Team size returned by the Sendora API.
          title: Team Size
        value_prop:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Value prop returned by the Sendora API.
          title: Value Prop
      required: []
      title: CompanyProfileUpdate
      type: object
    OrgSettingsUpdate:
      properties:
        client_default_perms:
          anyOf:
            - $ref: '#/components/schemas/ClientDefaultPerms'
            - type: 'null'
          description: Client default perms returned by the Sendora API.
        copilot_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Copilot name returned by the Sendora API.
          title: Copilot Name
        dashboard_cover:
          anyOf:
            - type: string
            - type: 'null'
          description: Dashboard cover returned by the Sendora API.
          title: Dashboard Cover
        name:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          description: Name returned by the Sendora API.
          title: Name
        timezone:
          anyOf:
            - type: string
            - type: 'null'
          description: Timezone returned by the Sendora API.
          title: Timezone
      required: []
      title: OrgSettingsUpdate
      type: object
    AccessUpdate:
      properties:
        grants:
          description: Extra permissions to give or take away on top of the role
          items:
            $ref: '#/components/schemas/Grant'
          title: Grants
          type: array
        role:
          description: admin, manager or viewer (read the list from the catalog)
          maxLength: 40
          minLength: 1
          title: Role
          type: string
        scopes:
          description: >-
            Limit this person to these campaigns or lead lists; empty means no
            limit
          items:
            $ref: '#/components/schemas/Scope'
          title: Scopes
          type: array
      required:
        - role
      title: AccessUpdate
      type: object
    ValidationError:
      properties:
        loc:
          description: Loc returned by the Sendora API.
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          description: Msg returned by the Sendora API.
          title: Message
          type: string
        type:
          description: Type returned by the Sendora API.
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    ClientDefaultPerms:
      properties:
        access_analytics:
          default: true
          description: Access analytics returned by the Sendora API.
          title: Access Analytics
          type: boolean
        ai_copilot:
          default: true
          description: Ai copilot returned by the Sendora API.
          title: Ai Copilot
          type: boolean
        campaigns:
          default: true
          description: Campaigns returned by the Sendora API.
          title: Campaigns
          type: boolean
        create_agents:
          default: true
          description: Create agents returned by the Sendora API.
          title: Create Agents
          type: boolean
        email:
          default: true
          description: Email returned by the Sendora API.
          title: Email
          type: boolean
        import_leads:
          default: true
          description: Import leads returned by the Sendora API.
          title: Import Leads
          type: boolean
        knowledge_base:
          default: true
          description: Knowledge base returned by the Sendora API.
          title: Knowledge Base
          type: boolean
        linkedin:
          default: true
          description: Linkedin returned by the Sendora API.
          title: Linkedin
          type: boolean
        manage_phone_numbers:
          default: false
          description: Manage phone numbers returned by the Sendora API.
          title: Manage Phone Numbers
          type: boolean
        public_api:
          default: false
          description: Public api returned by the Sendora API.
          title: Public Api
          type: boolean
        sms:
          default: true
          description: Sms returned by the Sendora API.
          title: Sms
          type: boolean
        voice:
          default: true
          description: Voice returned by the Sendora API.
          title: Voice
          type: boolean
        whatsapp:
          default: true
          description: Whatsapp returned by the Sendora API.
          title: Whatsapp
          type: boolean
      required: []
      title: ClientDefaultPerms
      type: object
    Grant:
      properties:
        effect:
          default: grant
          description: Effect returned by the Sendora API.
          enum:
            - grant
            - deny
          title: Effect
          type: string
        permission:
          description: A permission name from the catalog, for example campaigns.edit
          maxLength: 80
          minLength: 3
          title: Permission
          type: string
      required:
        - permission
      title: Grant
      type: object
    Scope:
      properties:
        resource_id:
          description: The campaign's or lead list's `id`
          maxLength: 80
          minLength: 1
          title: Resource Id
          type: string
        resource_type:
          description: Resource type returned by the Sendora API.
          enum:
            - campaign
            - lead_list
          title: Resource Type
          type: string
      required:
        - resource_type
        - resource_id
      title: Scope
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Customer API key created in the Sendora dashboard.
      in: header
      name: X-API-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.