> ## 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 signup settings

> Update signup settings. See the request and response schemas for the complete public API contract. 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 put /api/v1/public/partner/signup-config
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: Build, launch, pause and stop campaigns, and enroll leads.
    name: Campaigns
  - description: Create, update, tag, enrich and import leads.
    name: Leads
  - description: Group leads into reusable lists.
    name: Lead lists
  - description: Find new prospects and research existing leads.
    name: Prospecting
  - description: Read conversations and send messages to leads.
    name: Inbox
  - description: Manage workspace-wide suppressions.
    name: Do not contact
  - description: Manage the content your agents answer from.
    name: Knowledge bases
  - description: Create, configure, test and publish voice agents.
    name: Voice agents
  - description: Give agents actions such as booking, lookups and transfers.
    name: Agent tools
  - description: Embed a voice agent on your website.
    name: Voice widgets
  - description: Start voice calls and read call results.
    name: Calls
  - description: Browse and preview the voices an agent can use.
    name: Voices
  - description: List numbers, bring your own, and route calls.
    name: Phone numbers
  - description: List the channel accounts connected to the workspace.
    name: Connected accounts
  - description: Register endpoints and review deliveries.
    name: Webhooks
  - description: Drive the workspace assistant programmatically.
    name: Copilot
  - description: Read workspace and campaign performance.
    name: Analytics
  - description: Track asynchronous operations.
    name: Jobs
  - description: Manage client workspaces, plans and branding.
    name: Agency
paths:
  /api/v1/public/partner/signup-config:
    put:
      tags:
        - Agency
      summary: Update signup settings
      description: >-
        Update signup settings. See the request and response schemas for the
        complete public API contract. 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: >-
        public_partner_update_signup_config_api_v1_public_partner_signup_config_put
      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/SignupOnboardingConfigUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                title: >-
                  Response Public Partner Update Signup Config Api V1 Public
                  Partner Signup Config Put
                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 PUT
            'https://api.sendora.ai/api/v1/public/partner/signup-config' -H
            "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
              -d '{"company_name":"example","custom_font_name":"example","custom_font_url":"example"}'
        - label: Python
          lang: python
          source: >-
            import requests


            url = 'https://api.sendora.ai/api/v1/public/partner/signup-config'

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

            response = requests.put(url, headers=headers, json={'company_name':
            'example', 'custom_font_name': 'example', 'custom_font_url':
            '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/signup-config",
            {
              method: "PUT",
              headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
              body: JSON.stringify({"company_name": "example", "custom_font_name": "example", "custom_font_url": "example"}),
            });

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

            console.log(await response.json());
        - label: Go
          lang: go
          source: >-
            req, err := http.NewRequest("PUT",
            "https://api.sendora.ai/api/v1/public/partner/signup-config",
            bytes.NewBufferString(`{"company_name": "example",
            "custom_font_name": "example", "custom_font_url": "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:
    SignupOnboardingConfigUpdate:
      description: >-
        workspace-safe launch appearance, portal, signup, and onboarding
        settings.
      properties:
        company_name:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          description: Company name returned by the Sendora API.
          title: Company Name
        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:
            - pattern: ^questions$
              type: string
            - type: 'null'
          description: Onboarding mode returned by the Sendora API.
          title: Onboarding Mode
        onboarding_questions:
          anyOf:
            - items:
                additionalProperties: true
                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: SignupOnboardingConfigUpdate
      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
    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
  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.