Labels

​

What Labels are

​

Public API — send message

"labels": ["vip", "customers"]

• Works with destinationNumber or groupId.
• Label processing is asynchronous: upserts Labels by name and associates the destination.
• The platform may try to fill the contact display name from WhatsApp data on the connected instance when still empty.

​

Example

curl -X POST "https://pilotstatus.com.br/v1/messages/send" \
  -H "Content-Type: application/json" \
  -H "x-api-key: ps_your_key_here" \
  -d '{
    "destinationNumber": "+5511999999999",
    "templateId": "order_update",
    "labels": ["vip", "customers"]
  }'

{
  "id": "cmm04obm46zz0qv4ycjp8x6r2",
  "correlationId": "b3f1c2a4-9e7d-4c5a-8f21-0a1b2c3d4e5f",
  "status": "QUEUED",
  "createdAt": "2026-07-04T12:00:00.000Z",
  "origin": "api"
}

​

Retention (PII)

• STORE_INDEFINITE (default) — conversations and messages are stored indefinitely.
• STORE_X_DAYS — only the last N days of chat records are kept; older records are deleted daily.
• RELAY_ONLY — conversations aren’t persisted. Labels themselves are still created when you pass labels on the send API, but no conversation content is stored.

​

UI import

• Phone columns: same as Messages (number, destinationnumber, phone, etc.).
• Optional group column: groupId, group — if it ends with @g.us, the row is treated as GROUP.
• If the same destination already exists in the label with an empty name and the import provides a name, the name is updated.

​

Copy contact