> ## 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 client

> Update a client's branding, features, profile, monthly caps, access and people in one call.

Steps run in this order: branding, features, profile, limits (caps then access), people (invite, update, remove).
If a step fails, earlier steps stay applied and the error lists them under `applied`. 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/partner/clients/{client_id}
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/partner/clients/{client_id}:
    patch:
      tags:
        - Agency
      summary: Update client
      description: >-
        Update a client's branding, features, profile, monthly caps, access and
        people in one call.


        Steps run in this order: branding, features, profile, limits (caps then
        access), people (invite, update, remove).

        If a step fails, earlier steps stay applied and the error lists them
        under `applied`. 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_client_api_v1_public_partner_clients__client_id__patch
      parameters:
        - description: 'The client workspace''s id: the `id` from List clients.'
          in: path
          name: client_id
          required: true
          schema:
            title: Client Id
            type: string
        - 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/ClientPatchBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicClientFeature'
          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.
        '404':
          description: >-
            The resource does not exist or is not owned by the authenticated
            workspace.
        '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/partner/clients/YOUR_ID' -H
            "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
              -d '{"branding":{"company_name":"example","tagline":"example","primary_color":"example"},"features":{"flags":[{"key":"example","enabled":true}]},"profile":{"name":"example","owner_name":"example","owner_email":"example"}}'
        - label: Python
          lang: python
          source: >-
            import requests


            url = 'https://api.sendora.ai/api/v1/public/partner/clients/YOUR_ID'

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

            response = requests.patch(url, headers=headers, json={'branding':
            {'company_name': 'example', 'tagline': 'example', 'primary_color':
            'example'}, 'features': {'flags': [{'key': 'example', 'enabled':
            True}]}, 'profile': {'name': 'example', 'owner_name': 'example',
            'owner_email': 'example'}})

            response.raise_for_status()

            print(response.json())
        - label: JavaScript
          lang: javascript
          source: >-
            const response = await
            fetch("https://api.sendora.ai/api/v1/public/partner/clients/YOUR_ID",
            {
              method: "PATCH",
              headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
              body: JSON.stringify({"branding": {"company_name": "example", "tagline": "example", "primary_color": "example"}, "features": {"flags": [{"key": "example", "enabled": true}]}, "profile": {"name": "example", "owner_name": "example", "owner_email": "example"}}),
            });

            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/partner/clients/YOUR_ID",
            bytes.NewBufferString(`{"branding": {"company_name": "example",
            "tagline": "example", "primary_color": "example"}, "features":
            {"flags": [{"key": "example", "enabled": true}]}, "profile":
            {"name": "example", "owner_name": "example", "owner_email":
            "example"}}`))

            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:
    ClientPatchBody:
      properties:
        access:
          anyOf:
            - $ref: '#/components/schemas/ClientAccessUpdate'
            - type: 'null'
          description: Turn channels and app tabs on or off for this client.
        branding:
          anyOf:
            - $ref: '#/components/schemas/BrandingUpdate'
            - type: 'null'
          description: Branding returned by the Sendora API.
        features:
          anyOf:
            - $ref: '#/components/schemas/FeatureFlagsUpdate'
            - type: 'null'
          description: Features returned by the Sendora API.
        profile:
          anyOf:
            - $ref: '#/components/schemas/SubAccountUpdate'
            - type: 'null'
          description: >-
            Name, owner, custom domain, tier label, prompt prefix, private
            notes, account manager, renewal.
        usage_caps:
          anyOf:
            - $ref: '#/components/schemas/UsageCapsUpdate'
            - type: 'null'
          description: >-
            Monthly caps per channel; 0 stops it. Needs an agency owner or
            admin.
        users:
          anyOf:
            - $ref: '#/components/schemas/ClientPeople'
            - type: 'null'
          description: 'The client''s own people: invite, change access, remove.'
      required: []
      title: ClientPatchBody
      type: object
    PublicClientFeature:
      properties:
        enabled:
          description: Enabled returned by the Sendora API.
          title: Enabled
          type: boolean
        key:
          description: Key returned by the Sendora API.
          title: Key
          type: string
      required:
        - key
        - enabled
      title: PublicClientFeature
      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
    ClientAccessUpdate:
      properties:
        agents_tab_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Agents tab enabled returned by the Sendora API.
          title: Agents Tab Enabled
        campaign_builder_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Campaign builder enabled returned by the Sendora API.
          title: Campaign Builder Enabled
        campaigns_tab_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Campaigns tab enabled returned by the Sendora API.
          title: Campaigns Tab Enabled
        email_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Email enabled returned by the Sendora API.
          title: Email Enabled
        inbox_tab_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Inbox tab enabled returned by the Sendora API.
          title: Inbox Tab Enabled
        knowledge_tab_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Knowledge tab enabled returned by the Sendora API.
          title: Knowledge Tab Enabled
        leads_tab_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Leads tab enabled returned by the Sendora API.
          title: Leads Tab Enabled
        linkedin_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Linkedin enabled returned by the Sendora API.
          title: Linkedin Enabled
        settings_tab_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Settings tab enabled returned by the Sendora API.
          title: Settings Tab Enabled
        sms_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Sms enabled returned by the Sendora API.
          title: Sms Enabled
        voice_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Voice enabled returned by the Sendora API.
          title: Voice Enabled
        whatsapp_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whatsapp enabled returned by the Sendora API.
          title: Whatsapp Enabled
      required: []
      title: ClientAccessUpdate
      type: object
    BrandingUpdate:
      description: |-
        Partial-update payload, every field is optional so the operator can save
        one section without clobbering another. None means 'leave alone'; empty
        string means 'clear'.
      properties:
        company_name:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          description: Company name returned by the Sendora API.
          title: Company Name
        custom_domain:
          anyOf:
            - maxLength: 253
              type: string
            - type: 'null'
          description: Custom domain returned by the Sendora API.
          title: Custom Domain
        custom_font_name:
          anyOf:
            - maxLength: 100
              type: string
            - type: 'null'
          description: Custom font name returned by the Sendora API.
          title: Custom Font Name
        custom_font_url:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Custom font url returned by the Sendora API.
          title: Custom Font Url
        dark_logo_url:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Dark logo url returned by the Sendora API.
          title: Dark Logo Url
        email_footer:
          anyOf:
            - maxLength: 2000
              type: string
            - type: 'null'
          description: Email footer returned by the Sendora API.
          title: Email Footer
        favicon_url:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Favicon url returned by the Sendora API.
          title: Favicon Url
        font:
          anyOf:
            - maxLength: 50
              type: string
            - type: 'null'
          description: Font returned by the Sendora API.
          title: Font
        from_email:
          anyOf:
            - maxLength: 320
              type: string
            - type: 'null'
          description: From email returned by the Sendora API.
          title: From Email
        from_name:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          description: From name returned by the Sendora API.
          title: From Name
        logo_url:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Logo url returned by the Sendora API.
          title: Logo Url
        onboarding_layout:
          anyOf:
            - maxLength: 20
              type: string
            - type: 'null'
          description: Onboarding layout returned by the Sendora API.
          title: Onboarding Layout
        onboarding_mode:
          anyOf:
            - const: questions
              type: string
            - type: 'null'
          description: Onboarding mode returned by the Sendora API.
          title: Onboarding Mode
        onboarding_questions:
          anyOf:
            - items:
                type: object
              type: array
            - type: 'null'
          description: Onboarding questions returned by the Sendora API.
          title: Onboarding Questions
        onboarding_skip_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Onboarding skip enabled returned by the Sendora API.
          title: Onboarding Skip Enabled
        onboarding_split_visual_url:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Onboarding split visual url returned by the Sendora API.
          title: Onboarding Split Visual Url
        onboarding_welcome_message:
          anyOf:
            - maxLength: 1000
              type: string
            - type: 'null'
          description: Onboarding welcome message returned by the Sendora API.
          title: Onboarding Welcome Message
        portal_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Portal enabled returned by the Sendora API.
          title: Portal Enabled
        portal_slug:
          anyOf:
            - maxLength: 63
              type: string
            - type: 'null'
          description: Portal slug returned by the Sendora API.
          title: Portal Slug
        primary_color:
          anyOf:
            - type: string
            - type: 'null'
          description: Primary color returned by the Sendora API.
          title: Primary Color
        primary_color_dark:
          anyOf:
            - type: string
            - type: 'null'
          description: Primary color dark returned by the Sendora API.
          title: Primary Color Dark
        reply_to:
          anyOf:
            - maxLength: 320
              type: string
            - type: 'null'
          description: Reply to returned by the Sendora API.
          title: Reply To
        secondary_color:
          anyOf:
            - type: string
            - type: 'null'
          description: Secondary color returned by the Sendora API.
          title: Secondary Color
        show_sendora_branding:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Show sendora branding returned by the Sendora API.
          title: Show Sendora Branding
        signin_hero_image_url:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Signin hero image url returned by the Sendora API.
          title: Signin Hero Image Url
        signin_hero_video_url:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Signin hero video url returned by the Sendora API.
          title: Signin Hero Video Url
        signup_default_plan:
          anyOf:
            - maxLength: 64
              type: string
            - type: 'null'
          description: Signup default plan returned by the Sendora API.
          title: Signup Default Plan
        signup_mode:
          anyOf:
            - maxLength: 20
              type: string
            - type: 'null'
          description: Signup mode returned by the Sendora API.
          title: Signup Mode
        signup_require_payment:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Signup require payment returned by the Sendora API.
          title: Signup Require Payment
        signup_trial_days:
          anyOf:
            - maximum: 365
              minimum: 0
              type: integer
            - type: 'null'
          description: Signup trial days returned by the Sendora API.
          title: Signup Trial Days
        support_email:
          anyOf:
            - maxLength: 320
              type: string
            - type: 'null'
          description: Support email returned by the Sendora API.
          title: Support Email
        tagline:
          anyOf:
            - maxLength: 300
              type: string
            - type: 'null'
          description: Tagline returned by the Sendora API.
          title: Tagline
        welcome_message:
          anyOf:
            - maxLength: 1000
              type: string
            - type: 'null'
          description: Welcome message returned by the Sendora API.
          title: Welcome Message
      required: []
      title: BrandingUpdate
      type: object
    FeatureFlagsUpdate:
      properties:
        flags:
          description: Flags returned by the Sendora API.
          items:
            $ref: '#/components/schemas/FeatureFlag'
          title: Flags
          type: array
      required:
        - flags
      title: FeatureFlagsUpdate
      type: object
    SubAccountUpdate:
      description: Partial edit of a sub-account's display + plan metadata.
      properties:
        account_manager_name:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          description: Account manager name returned by the Sendora API.
          title: Account Manager Name
        contract_length_months:
          anyOf:
            - maximum: 1200
              minimum: 0
              type: integer
            - type: 'null'
          description: Contract length months returned by the Sendora API.
          title: Contract Length Months
        custom_domain:
          anyOf:
            - maxLength: 253
              type: string
            - type: 'null'
          description: Custom domain returned by the Sendora API.
          title: Custom Domain
        internal_notes:
          anyOf:
            - maxLength: 5000
              type: string
            - type: 'null'
          description: Internal notes returned by the Sendora API.
          title: Internal Notes
        name:
          anyOf:
            - maxLength: 200
              minLength: 1
              type: string
            - type: 'null'
          description: Name returned by the Sendora API.
          title: Name
        owner_email:
          anyOf:
            - maxLength: 320
              type: string
            - type: 'null'
          description: Owner email returned by the Sendora API.
          title: Owner Email
        owner_name:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          description: Owner name returned by the Sendora API.
          title: Owner Name
        plan:
          anyOf:
            - maxLength: 50
              type: string
            - type: 'null'
          description: Plan returned by the Sendora API.
          title: Plan
        renewal_date:
          anyOf:
            - maxLength: 10
              type: string
            - type: 'null'
          description: Renewal date returned by the Sendora API.
          title: Renewal Date
        system_prompt_prefix:
          anyOf:
            - maxLength: 4000
              type: string
            - type: 'null'
          description: System prompt prefix returned by the Sendora API.
          title: System Prompt Prefix
        tier_label:
          anyOf:
            - maxLength: 50
              type: string
            - type: 'null'
          description: Tier label returned by the Sendora API.
          title: Tier Label
      required: []
      title: SubAccountUpdate
      type: object
    UsageCapsUpdate:
      properties:
        monthly_ai_credit_cap:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: Monthly ai credit cap returned by the Sendora API.
          title: Monthly Ai Credit Cap
        monthly_call_cap:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: Monthly call cap returned by the Sendora API.
          title: Monthly Call Cap
        monthly_email_cap:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: Monthly email cap returned by the Sendora API.
          title: Monthly Email Cap
        monthly_lead_cap:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: Monthly lead cap returned by the Sendora API.
          title: Monthly Lead Cap
        monthly_linkedin_cap:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: Monthly linkedin cap returned by the Sendora API.
          title: Monthly Linkedin Cap
        monthly_sms_cap:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: Monthly sms cap returned by the Sendora API.
          title: Monthly Sms Cap
        monthly_whatsapp_cap:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: Monthly whatsapp cap returned by the Sendora API.
          title: Monthly Whatsapp Cap
      required: []
      title: UsageCapsUpdate
      type: object
    ClientPeople:
      properties:
        invite:
          anyOf:
            - items:
                $ref: '#/components/schemas/ClientPerson'
              maxItems: 20
              type: array
            - type: 'null'
          description: People to invite by email; no password is set.
          title: Invite
        remove:
          anyOf:
            - items:
                type: string
              maxItems: 20
              type: array
            - type: 'null'
          description: Emails of people to remove.
          title: Remove
        update:
          anyOf:
            - items:
                $ref: '#/components/schemas/ClientPerson'
              maxItems: 20
              type: array
            - type: 'null'
          description: People whose portal mode or visible areas change, found by email.
          title: Update
      required: []
      title: ClientPeople
      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
    FeatureFlag:
      properties:
        enabled:
          description: Enabled returned by the Sendora API.
          title: Enabled
          type: boolean
        key:
          description: Key returned by the Sendora API.
          title: Key
          type: string
      required:
        - key
        - enabled
      title: FeatureFlag
      type: object
    ClientPerson:
      properties:
        email:
          description: The person's email; it identifies them in this client's workspace.
          maxLength: 320
          title: Email
          type: string
        name:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          description: Invite only.
          title: Name
        portal_mode:
          anyOf:
            - enum:
                - full
                - readonly
                - inbox_only
              type: string
            - type: 'null'
          description: Leave out to inherit the client's default.
          title: Portal Mode
        visible_tabs:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          description: >-
            Which areas they see:
            {campaigns|agents|inbox|leads|knowledge|settings: view or edit}; a
            missing area is hidden.
          title: Visible Tabs
      required:
        - email
      title: ClientPerson
      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.