Skip to main content
POST
Add or remove label

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
number
string
required

Recipient phone number in international format (non-empty).

Example:

"5511999999999"

labelId
string
required

Identifier of the label to apply or remove (non-empty).

Example:

"1"

action
string
required

Operation to perform; either add or remove.

Example:

"add"

Response

Success — provider-native response body.

Result of adding or removing a label from a chat. The boolean flag reflects the action performed: add is present for the add action, remove for the remove action.

numberJid
string
required

The WhatsApp JID of the chat the label was applied to or removed from.

labelId
string
required

The id of the label that was handled.

add
boolean

Present and true when the label was added to the chat (action = add).

remove
boolean

Present and true when the label was removed from the chat (action = remove).