Updates the custom fields of an instance. Allows configuring up to 20 custom fields to store additional information about leads.
Each field can store up to 255 characters and accepts any type of data.
Available fields:
Usage examples:
Request example:
{
"lead_field01": "name",
"lead_field02": "email",
"lead_field03": "phone",
"lead_field04": "city",
"lead_field05": "state",
"lead_field06": "age",
"lead_field07": "interests",
"lead_field08": "source",
"lead_field09": "status",
"lead_field10": "value",
"lead_field11": "notes",
"lead_field12": "last_interaction",
"lead_field13": "next_contact",
"lead_field14": "seller",
"lead_field15": "product_interest",
"lead_field16": "capture_source",
"lead_field17": "score",
"lead_field18": "tags",
"lead_field19": "history",
"lead_field20": "custom"
}
Response example:
{
"success": true,
"message": "Custom fields updated successfully",
"instance": {
"id": "r183e2ef9597845",
"name": "my-instance",
"fieldsMap": {
"lead_field01": "name",
"lead_field02": "email",
"lead_field03": "phone",
"lead_field04": "city",
"lead_field05": "state",
"lead_field06": "age",
"lead_field07": "interests",
"lead_field08": "source",
"lead_field09": "status",
"lead_field10": "value",
"lead_field11": "notes",
"lead_field12": "last_interaction",
"lead_field13": "next_contact",
"lead_field14": "seller",
"lead_field15": "product_interest",
"lead_field16": "capture_source",
"lead_field17": "score",
"lead_field18": "tags",
"lead_field19": "history",
"lead_field20": "custom"
}
}
}
Common errors:
Restrictions:
Custom field 01
255Custom field 02
255Custom field 03
255Custom field 04
255Custom field 05
255Custom field 06
255Custom field 07
255Custom field 08
255Custom field 09
255Custom field 10
255Custom field 11
255Custom field 12
255Custom field 13
255Custom field 14
255Custom field 15
255Custom field 16
255Custom field 17
255Custom field 18
255Custom field 19
255Custom field 20
255Success
Representa uma instância do WhatsApp
ID único gerado automaticamente
Token de autenticação da instância
Status atual da conexão
Código de pareamento
QR Code em base64 para autenticação
Nome da instância
Nome do perfil WhatsApp
URL da foto do perfil
Indica se é uma conta business
Plataforma de origem (iOS/Android/Web)
Nome do sistema operacional
Proprietário da instância
Data/hora da última desconexão
Motivo da última desconexão
Campo administrativo 01
Campo administrativo 02
Chave da API OpenAI
Habilitar chatbot automático
Ignorar mensagens de grupos
Palavra-chave para parar conversa
Por quanto tempo ficará pausado o chatbot ao usar stop conversation
Por quanto tempo ficará pausada a conversa quando você enviar mensagem manualmente
Data de criação da instância
Data da última atualização
Delay mínimo em segundos entre mensagens diretas
x >= 1Delay máximo em segundos entre mensagens diretas (deve ser maior que delayMin)
x >= 1