Skip to main content
POST
/
instance
/
updateFieldsMap
Update lead custom fields
curl --request POST \
  --url https://api.wppfy.com/instance/updateFieldsMap \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "lead_field01": "<string>",
  "lead_field02": "<string>",
  "lead_field03": "<string>",
  "lead_field04": "<string>",
  "lead_field05": "<string>",
  "lead_field06": "<string>",
  "lead_field07": "<string>",
  "lead_field08": "<string>",
  "lead_field09": "<string>",
  "lead_field10": "<string>",
  "lead_field11": "<string>",
  "lead_field12": "<string>",
  "lead_field13": "<string>",
  "lead_field14": "<string>",
  "lead_field15": "<string>",
  "lead_field16": "<string>",
  "lead_field17": "<string>",
  "lead_field18": "<string>",
  "lead_field19": "<string>",
  "lead_field20": "<string>"
}
'
{
  "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
lead_field01
string

Custom field 01

Maximum string length: 255
lead_field02
string

Custom field 02

Maximum string length: 255
lead_field03
string

Custom field 03

Maximum string length: 255
lead_field04
string

Custom field 04

Maximum string length: 255
lead_field05
string

Custom field 05

Maximum string length: 255
lead_field06
string

Custom field 06

Maximum string length: 255
lead_field07
string

Custom field 07

Maximum string length: 255
lead_field08
string

Custom field 08

Maximum string length: 255
lead_field09
string

Custom field 09

Maximum string length: 255
lead_field10
string

Custom field 10

Maximum string length: 255
lead_field11
string

Custom field 11

Maximum string length: 255
lead_field12
string

Custom field 12

Maximum string length: 255
lead_field13
string

Custom field 13

Maximum string length: 255
lead_field14
string

Custom field 14

Maximum string length: 255
lead_field15
string

Custom field 15

Maximum string length: 255
lead_field16
string

Custom field 16

Maximum string length: 255
lead_field17
string

Custom field 17

Maximum string length: 255
lead_field18
string

Custom field 18

Maximum string length: 255
lead_field19
string

Custom field 19

Maximum string length: 255
lead_field20
string

Custom field 20

Maximum string length: 255

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