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

# Renomear instância

> Atualiza o nome interno usado para identificar a instância.

Atualiza o nome interno usado para identificar a instância.


## OpenAPI

````yaml PUT /instances/{instanceId}/token/{instanceToken}/update-name
openapi: 3.0.3
info:
  title: EZ API
  version: 1.0.0
  description: >-
    Documentação pública reconstruída a partir da collection WA Gateway e
    validada contra os endpoints públicos existentes da EZ API.
servers:
  - url: https://api.ezapi.com.br
    description: Produção
  - url: http://localhost:3000
    description: Desenvolvimento local
security:
  - ClientToken: []
tags:
  - name: Instância
    description: >-
      Crie, conecte, monitore e ajuste o comportamento da sua instância do
      WhatsApp.
  - name: Mensagens
    description: >-
      Envie mensagens assíncronas em texto, mídia, interativos e recursos
      avançados.
  - name: Conversas
    description: Endpoints de conversas.
  - name: Contatos
    description: Endpoints de contatos.
  - name: Privacidade
    description: Endpoints de privacidade.
  - name: Grupos
    description: >-
      Crie grupos, gerencie participantes, convites, foto, descrição e
      permissões.
  - name: Status
    description: Endpoints de status.
  - name: Fila de mensagens
    description: Endpoints de fila de mensagens.
  - name: WhatsApp Business
    description: Endpoints de whatsapp business.
  - name: Webhooks
    description: Configure URLs HTTPS para receber eventos em tempo real da EZ API.
paths:
  /instances/{instanceId}/token/{instanceToken}/update-name:
    put:
      tags:
        - Instância
      summary: Renomear instância
      description: Atualiza o nome interno usado para identificar a instância.
      operationId: instance_update-name
      parameters:
        - name: instanceId
          in: path
          required: true
          description: Identificador único da instância.
          schema:
            type: string
            example: abc1234567890
        - name: instanceToken
          in: path
          required: true
          description: Token privado da instância retornado na criação.
          schema:
            type: string
            example: tok_a1b2c3d4e5f6
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                value:
                  type: string
                  example: Novo nome da instância
              required:
                - value
              example:
                value: Novo nome da instância
            examples:
              renomear-instancia:
                summary: Renomear instância
                value:
                  value: Novo nome da instância
      responses:
        '200':
          description: Resposta de sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: boolean
                    example: true
                required:
                  - value
                example:
                  value: true
              example:
                value: true
        '401':
          description: Client-Token ou instanceToken inválido
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unauthorized
                message: Invalid instanceToken
        '404':
          description: Instância ou recurso não encontrado
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Instance not found
      security:
        - ClientToken: []
components:
  securitySchemes:
    ClientToken:
      type: apiKey
      in: header
      name: Client-Token

````