---
title: "Update Phone Number"
method: PUT
path: "/user/phone-numbers/{id}"
tags: ["Phone Numbers"]
---

# Update Phone Number

`PUT /user/phone-numbers/{id}`

## Request

- Base URL: `https://app.famulor.de/api`
- URL: `https://app.famulor.de/api/user/phone-numbers/{id}`
- Auth: HTTP bearer

Update a phone number's nickname

[Docs](https://docs.famulor.io/api-v1/phone-numbers/update)

## Path parameters

- `id` integer, required

## Request body

- object
  - `nickname` string: A short label for the phone number. Maximum 50 characters. Send `null` or an empty string to clear it.

## Response `200`

Response

- object
  - `message` string: Success message
  - `data` object: The updated phone number
    - `id` integer: The unique identifier of the phone number
    - `phone_number` string: The phone number in E.164 format
    - `nickname` string: The phone number's nickname (or `null` if not set)
    - `country_code` string: The ISO 3166-1 alpha-2 country code
    - `type` string: The type of phone number: `normal`, `sip`, or `caller_id`

## Other responses

- `401`: Fehlender oder ungültiger API-Key.
- `404`: Not Found
- `422`: Validation Error

---

[API](https://skmtc.dev/famulor/apis/famulor-api.md) · [All operations](https://skmtc.dev/famulor/apis/famulor-api/llms.txt) · [OpenAPI document](https://skmtc.dev/famulor/apis/famulor-api/revisions/3b938c370721?raw)