Skip to main content
POST
Create a new label

Description

This endpoint allows you to create a new label to organize your chats. Labels are useful for categorizing chats by themes, priorities or any custom criteria.

URL Parameters

string
required
WhatsApp unique session ID

Request Body

string
Custom ID of the label (optional)
string
required
Name of the label
number
required
Numeric code of the label color

Response

boolean
Indicates if the label was created successfully

Status Codes

  • 200 - Label created successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized

Usage Example

Authorizations

apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

session
string
required

Session name (instanceName)

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

201 - 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"