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

# Atualizar número de telefone

> Atualizar o apelido de um número de telefone

Este endpoint atualiza os atributos editáveis de um número de telefone que você possui. Atualmente, este é o **apelido** — um rótulo curto e amigável (por exemplo, "Linha de Vendas", "Suporte — EUA") exibido ao lado do número no painel.

Somente o **proprietário** do número pode atualizá-lo. Números compartilhados com você (concedidos) exibem o apelido, mas não podem ser alterados por você.

### Parâmetros de Caminho

<ParamField path="id" type="integer" required>
  O identificador único do número de telefone a ser atualizado
</ParamField>

### Parâmetros do Corpo

<ParamField body="nickname" type="string">
  Um rótulo curto para o número de telefone. Máximo de 50 caracteres. Envie `null` ou uma string vazia para removê-lo.
</ParamField>

### Resposta

<ResponseField name="message" type="string">
  Mensagem de sucesso
</ResponseField>

<ResponseField name="data" type="object">
  O número de telefone atualizado

  <Expandable title="propriedades">
    <ResponseField name="id" type="integer">
      O identificador único do número de telefone
    </ResponseField>

    <ResponseField name="phone_number" type="string">
      O número de telefone no formato E.164
    </ResponseField>

    <ResponseField name="nickname" type="string">
      O apelido do número de telefone (ou `null` se não estiver definido)
    </ResponseField>

    <ResponseField name="country_code" type="string">
      O código do país ISO 3166-1 alpha-2
    </ResponseField>

    <ResponseField name="type" type="string">
      O tipo de número de telefone: `normal`, `sip` ou `caller_id`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 Resposta theme={null}
  {
    "message": "Número de telefone atualizado com sucesso.",
    "data": {
      "id": 1,
      "phone_number": "+14155551234",
      "nickname": "Linha de Vendas",
      "country_code": "US",
      "type": "normal"
    }
  }
  ```

  ```json 404 Não Encontrado theme={null}
  {
    "error": "Número de telefone não encontrado."
  }
  ```

  ```json 422 Erro de Validação theme={null}
  {
    "message": "O apelido não deve exceder 50 caracteres.",
    "errors": {
      "nickname": ["O apelido não deve exceder 50 caracteres."]
    }
  }
  ```
</ResponseExample>

<Note>
  O apelido é o mesmo rótulo que você pode definir no painel. Ele é retornado pelos endpoints de listagem de números de telefone (`GET /user/phone-numbers/all`, `GET /user/phone-numbers/sip-trunks`), então outros recursos que referenciam um número pelo `phone_number_id` podem resolver seu apelido a partir daí.
</Note>


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