Atualizar nome da instância

Amb. de Desenv.

http://localhost:3000

PATCH

/instances/{instanceId}

Atualiza apenas o nome da instância informada.

Use esta rota quando precisar renomear uma instância sem alterar outras configurações.

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200OK

application/json

The request has succeeded.

Body

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'http://localhost:3000/instances/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Atendimento Comercial"
}'

Response Example

200 - Nome atualizado

{
    "instanceId": "018f47ac-7a5b-7cc2-9f9a-9b8d7f6e5d4c",
    "name": "Atendimento Comercial"
}

Modificado em 2026-04-17 20:31:44