Skip to main content
PUT
/
api
/
{session}
/
labels
/
{labelId}
Atualizar uma etiqueta
curl --request PUT \
  --url https://{host}/api/{session}/labels/{labelId} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "name": "Lead",
  "colorHex": "#ff9485",
  "color": null
}'
{
  "success": true,
  "label": {
    "id": "label123",
    "name": "Clientes Premium",
    "color": 3
  }
}

​
Descrição

Este endpoint permite atualizar as informações de um rótulo existente, como seu nome e cor.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp
​
labelId
string
required
ID do rótulo a ser atualizado

​
Corpo da Requisição

​
name
string
required
Novo nome do rótulo
​
color
number
required
Novo código numérico da cor do rótulo

​
Resposta

​
success
boolean
Indica se o rótulo foi atualizado com sucesso
{
  "success": true,
  "label": {
    "id": "label123",
    "name": "Clientes Premium",
    "color": 3
  }
}

​
Códigos de Status

  • 200 - Rótulo atualizado com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Não autorizado
  • 404 - Rótulo não encontrado

​
Exemplo de Uso

curl -X PUT https://api.wappfy.com.br/api/my-session/labels/label123 \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Clientes Premium",
    "color": 3
  }'

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

​
labelId
string
required

Body

application/json
​
name
string
required

Label name

Example:

"Lead"

​
colorHex
string

Color in hex

Example:

"#ff9485"

​
color
number

Color number, not hex

Example:

null

Response

200 - application/json
​
id
string
required

Label ID

Example:

"1"

​
name
string
required

Label name

Example:

"Lead"

​
color
number
required

Color number, not hex

Example:

0

​
colorHex
string
required

Color in hex

Example:

"#ff9485"

⌘I