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

# Update User Phone Number

> Edit the label of a primary or extra phone assignment. Omit label to leave it unchanged; null or an empty string clears it. The number, primary designation and verification remain unchanged.

## Authentication and permissions

> **Token requirements:** **Organization-scoped API key**.
>
> Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

| Credential | Access requirements |
| - | - |
| Organization-scoped API key | `users:manage` |
| Team-scoped API key | Unsupported |
| User-based token (OAuth) | Unsupported |

Permissions joined by **+** are all required; **or** separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.


## OpenAPI

````yaml /sections/api-reference/openapi-spec-v2.yaml patch /v2/users/{user_id}/phone-numbers/{phone_number_id}
openapi: 3.1.0
info:
  title: Serval Public API
  description: Serval Public API
  contact:
    name: Serval
    url: https://serval.com
    email: support@serval.com
  license:
    name: Serval License
    url: https://serval.com/license
  version: 2.0.0
servers:
  - url: https://public.api.serval.com
security:
  - BearerAuth: []
tags:
  - name: Access Membership API
  - name: Access Policy API
  - name: Access Policy Approval Procedure API
  - name: Access Profile API
  - name: Access Relationship API
  - name: Access Request API
  - name: Agent API
  - name: Analytics API
  - name: App Instance API
  - name: App Resource API
  - name: App Resource Role API
  - name: Approval Delegation API
  - name: Approval Procedure API
  - name: Approval Request API
  - name: Assignment Rules API
  - name: Audit Log API
  - name: Billing API
  - name: Browser API
  - name: Campaign API
  - name: Change Blackout API
  - name: Change Model API
  - name: Connected Channels API
  - name: Custom Field API
  - name: Custom Role API
  - name: Custom Service API
  - name: Dashboards API
  - name: Email Intake API
  - name: Entity API
  - name: Entity Field Mapping API
  - name: Entity Ingestion Config API
  - name: Entity Type API
  - name: Folder API
  - name: Forms API
  - name: Group API
  - name: Guidance API
  - name: Help Agent API
  - name: Journey API
  - name: Knowledge API
  - name: Knowledge Base API
  - name: One-Time Window API
  - name: Package API
  - name: Report API
  - name: Review API
  - name: Roles API
  - name: SLA API
  - name: Schedule API
  - name: Tag API
  - name: Team API
  - name: Team Group API
  - name: Team SDLC Settings API
  - name: Team User API
  - name: Ticket API
  - name: Topic API
  - name: User API
  - name: User Relationship API
  - name: Widgets API
  - name: Worker API
  - name: Workflow API
  - name: Workflow Approval Procedure API
  - name: Workflow Run API
paths:
  /v2/users/{user_id}/phone-numbers/{phone_number_id}:
    patch:
      tags:
        - User API
      summary: Update User Phone Number
      description: >-
        Edit the label of a primary or extra phone assignment. Omit label to
        leave it unchanged; null or an empty string clears it. The number,
        primary designation and verification remain unchanged.
      operationId: svrelay.publicv2.PublicAPIServiceV2.UpdateUserPhoneNumber
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            title: user_id
        - name: phone_number_id
          in: path
          required: true
          schema:
            type: string
            title: phone_number_id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  anyOf:
                    - type: string
                    - type: 'null'
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/svauth.public.UpdateUserPhoneNumberResponse
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneAPIError'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneAPIError'
        '403':
          description: The token cannot perform this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneAPIError'
        '404':
          description: >-
            The mutation target is missing or unavailable to this user and
            organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneAPIError'
      security:
        - BearerAuth: []
components:
  schemas:
    svauth.public.UpdateUserPhoneNumberResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/svauth.public.UserPhoneNumber'
          title: data
          readOnly: true
          x-stainless-terraform-configurability: computed
      title: UpdateUserPhoneNumberResponse
      required:
        - data
      additionalProperties: false
    PhoneAPIError:
      type: object
      properties:
        code:
          type: integer
          description: Numeric gRPC status code.
          x-stainless-terraform-configurability: required
        message:
          type: string
          x-stainless-terraform-configurability: required
        details:
          type: array
          items:
            type: object
            additionalProperties: true
          x-stainless-terraform-configurability: optional
      required:
        - code
        - message
    svauth.public.UserPhoneNumber:
      type: object
      properties:
        id:
          type: string
          title: id
          readOnly: true
          x-stainless-terraform-configurability: computed
        e164:
          type: string
          title: e164
          readOnly: true
          x-stainless-terraform-configurability: computed
        verifiedForMagicLinkLogin:
          type: boolean
          title: verified_for_magic_link_login
          readOnly: true
          x-stainless-terraform-configurability: computed
        isPrimary:
          type: boolean
          title: is_primary
          readOnly: true
          x-stainless-terraform-configurability: computed
        label:
          type:
            - string
            - 'null'
          title: label
          readOnly: true
          x-stainless-terraform-configurability: computed
      title: UserPhoneNumber
      required:
        - id
        - e164
        - verifiedForMagicLinkLogin
        - isPrimary
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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