Settings

Rename Instance

Updates the internal name of the instance. Returns the full instance object.

POSThttps://api.zapzapapi.com/api/v1/{instanceId}/instance/updateInstanceName

Authentication with the x-api-key and x-api-secret headers.

Parameters

Name	Type	In	Required	Description
`name`	text	body	Yes	New name for the instance

Request example

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/instance/updateInstanceName" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"name":"Minha Nova Instância 2024!@#"}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/instance/updateInstanceName", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Minha Nova Instância 2024!@#"
  }),
});
console.log(await res.json());

Python

import requests

res = requests.post(
    "https://api.zapzapapi.com/api/v1/{instanceId}/instance/updateInstanceName",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
    json={"name":"Minha Nova Instância 2024!@#"},
)
print(res.json())

Response example

JSON

{
  "id": "raa287d88df6336",
  "name": "Novo Nome",
  "status": "connected",
  "profileName": "Meu Perfil",
  "owner": "5511999999999"
}

Values are illustrative; the fields follow the real response format.

Other endpoints in this category

See the full reference

Get your API keys

Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.

Create free account View the documentation