Skip to main content
POST
/
instance
/
updateInstanceName
Update instance name
curl --request POST \
  --url https://api.wppfy.com/instance/updateInstanceName \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "name": "My New Instance 2024!@#"
}
'
{
  "id": "i91011ijkl",
  "token": "abc123xyz",
  "status": "connected",
  "paircode": "1234-5678",
  "qrcode": "data:image/png;base64,iVBORw0KGg...",
  "name": "Instância Principal",
  "profileName": "Loja ABC",
  "profilePicUrl": "https://example.com/profile.jpg",
  "isBusiness": true,
  "plataform": "Android",
  "systemName": "WppFy",
  "owner": "user@example.com",
  "lastDisconnect": "2025-01-24T14:00:00Z",
  "lastDisconnectReason": "Network error",
  "adminField01": "custom_data",
  "openai_apikey": "sk-...xyz",
  "chatbot_enabled": true,
  "chatbot_ignoreGroups": true,
  "chatbot_stopConversation": "parar",
  "chatbot_stopMinutes": 60,
  "created": "2025-01-24T14:00:00Z",
  "updated": "2025-01-24T14:30:00Z",
  "delayMin": 2,
  "delayMax": 4
}

Authorizations

token
string
header
required

Body

application/json
name
string
required

New name for the instance

Example:

"My New Instance 2024!@#"

Response

Success

Representa uma instância do WhatsApp

id
string<uuid>

ID único gerado automaticamente

token
string

Token de autenticação da instância

status
string

Status atual da conexão

paircode
string

Código de pareamento

qrcode
string

QR Code em base64 para autenticação

name
string

Nome da instância

profileName
string

Nome do perfil WhatsApp

profilePicUrl
string<uri>

URL da foto do perfil

isBusiness
boolean

Indica se é uma conta business

plataform
string

Plataforma de origem (iOS/Android/Web)

systemName
string

Nome do sistema operacional

owner
string

Proprietário da instância

lastDisconnect
string<date-time>

Data/hora da última desconexão

lastDisconnectReason
string

Motivo da última desconexão

adminField01
string

Campo administrativo 01

adminField02
string

Campo administrativo 02

openai_apikey
string

Chave da API OpenAI

chatbot_enabled
boolean

Habilitar chatbot automático

chatbot_ignoreGroups
boolean

Ignorar mensagens de grupos

chatbot_stopConversation
string

Palavra-chave para parar conversa

chatbot_stopMinutes
integer

Por quanto tempo ficará pausado o chatbot ao usar stop conversation

chatbot_stopWhenYouSendMsg
integer

Por quanto tempo ficará pausada a conversa quando você enviar mensagem manualmente

created
string<date-time>

Data de criação da instância

updated
string<date-time>

Data da última atualização

msg_delay_min
integer<int64>
default:2

Delay mínimo em segundos entre mensagens diretas

Required range: x >= 1
msg_delay_max
integer<int64>
default:4

Delay máximo em segundos entre mensagens diretas (deve ser maior que delayMin)

Required range: x >= 1