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

> Set the inbound agent, outbound calling, the agent a number belongs to, its caller ID name, verified caller ID and sender ID. Steps: profile, outbound setup, inbound agent, then the settings. 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/phone-numbers/{number_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/phone-numbers/{number_id}:
    patch:
      tags:
        - Calls and numbers
      summary: Update number
      description: >-
        Set the inbound agent, outbound calling, the agent a number belongs to,
        its caller ID name, verified caller ID and sender ID. Steps: profile,
        outbound setup, inbound agent, then the settings. 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_number_api_v1_public_phone_numbers__number_id__patch
      parameters:
        - description: 'The phone number''s id: the `id` from List numbers.'
          in: path
          name: number_id
          required: true
          schema:
            title: Number 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/NumberPatchBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberUpdateOut'
          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/phone-numbers/YOUR_ID' -H
            "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
              -d '{"inbound_agent_id":"example","outbound_setup":{},"outbound_profile":{}}'
        - label: Python
          lang: python
          source: >-
            import requests


            url = 'https://api.sendora.ai/api/v1/public/phone-numbers/YOUR_ID'

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

            response = requests.patch(url, headers=headers,
            json={'inbound_agent_id': 'example', 'outbound_setup': {},
            'outbound_profile': {}})

            response.raise_for_status()

            print(response.json())
        - label: JavaScript
          lang: javascript
          source: >-
            const response = await
            fetch("https://api.sendora.ai/api/v1/public/phone-numbers/YOUR_ID",
            {
              method: "PATCH",
              headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
              body: JSON.stringify({"inbound_agent_id": "example", "outbound_setup": {}, "outbound_profile": {}}),
            });

            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/phone-numbers/YOUR_ID",
            bytes.NewBufferString(`{"inbound_agent_id": "example",
            "outbound_setup": {}, "outbound_profile": {}}`))

            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:
    NumberPatchBody:
      properties:
        agent_caller_id_name:
          anyOf:
            - maxLength: 40
              type: string
            - type: 'null'
          description: >-
            With assigned_agent_id: the name shown on calls instead of the
            agent's.
          title: Agent Caller Id Name
        alpha_sender:
          anyOf:
            - maxLength: 64
              type: string
            - type: 'null'
          description: >-
            Alphanumeric sender ID for texts abroad: 1 to 11 characters with a
            letter. Empty clears it.
          title: Alpha Sender
        assigned_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The voice agent this is assigned to: an `id` from List or get
            agents.
          title: Assigned Agent Id
        caller_id_name:
          anyOf:
            - maxLength: 40
              minLength: 1
              type: string
            - type: 'null'
          description: >-
            The name recipients see on calls (CNAM), up to 15 letters and
            digits.
          title: Caller Id Name
        inbound_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The voice agent that answers incoming calls: an `id` from List or
            get agents.
          title: Inbound Agent Id
        outbound_profile:
          anyOf:
            - type: object
            - type: 'null'
          description: Create an outbound calling profile for this number.
          title: Outbound Profile
        outbound_setup:
          anyOf:
            - type: object
            - type: 'null'
          description: Outbound calling settings for this number.
          title: Outbound Setup
        verified_caller_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            A verified caller ID's `id` to show on outbound calls. Send null to
            clear it.
          title: Verified Caller Id
      required: []
      title: NumberPatchBody
      type: object
    NumberUpdateOut:
      additionalProperties: true
      properties:
        inbound:
          anyOf:
            - type: object
            - type: 'null'
          description: Inbound returned by the Sendora API.
          title: Inbound
        outbound_profile:
          anyOf:
            - type: object
            - type: 'null'
          description: Outbound profile returned by the Sendora API.
          title: Outbound Profile
        outbound_setup:
          anyOf:
            - type: object
            - type: 'null'
          description: Outbound setup returned by the Sendora API.
          title: Outbound Setup
        settings:
          anyOf:
            - type: object
            - type: 'null'
          description: Settings returned by the Sendora API.
          title: Settings
      required: []
      title: NumberUpdateOut
      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.