Update Phone Number

openapi: 3.1.0
info:
  title: Update Phone Number
  version: 1.0.0

paths:
  /api/phone-numbers/{id}:
    patch:
      summary: Update a phone number
      description: Updates the configuration of an existing phone number.
      tags:
        - Phone Numbers

      security:
        - bearerAuth: []

      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: Unique identifier of the phone number.

      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                phoneNumber:
                  type: string
                  example: "+14155552671"
                provider:
                  type: string
                  example: Twilio
                assignedAgentId:
                  type: string
                  example: 686ab1234567890abcdef123
                status:
                  type: string
                  enum:
                    - Active
                    - Inactive

      responses:
        "200":
          description: Phone number updated successfully.

        "400":
          description: Invalid request.

        "401":
          description: Unauthorized.

        "404":
          description: Phone number not found.

        "500":
          description: Internal Server Error.

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

curl --location --request PATCH '{{baseUrl}}/api/phone-numbers/6872d4b5f8d7a91234567890' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
  "assignedAgentId": "686ab1234567890abcdef123",
  "status": "Active"
}'

{
  "success": true,
  "message": "Phone number updated successfully.",
  "data": {
    "_id": "6872d4b5f8d7a91234567890",
    "phoneNumber": "+14155552671",
    "provider": "Twilio",
    "status": "Active",
    "assignedAgent": "Customer Support Agent",
    "updatedAt": "2026-07-22T09:15:42.000Z"
  }
}

{
  "success": false,
  "message": "Invalid request payload."
}

{
  "success": false,
  "message": "Unauthorized"
}

{
  "success": false,
  "message": "Phone number not found."
}

{
  "success": false,
  "message": "Failed to update phone number."
}