API Reference

Receiving Events

contact.updated

WhatsApp address-book names changed (not whatsapp-protocol). Update only supplied data.contact.address_book fields: empty strings clear values, omitted fields stay unchanged, and null is invalid. Does not overwrite nicknames or the account profile. contact.id identifies the contact resource, not necessarily a conversation.

Event payload

{
  "id": "0000000000000000000000000000000000000000000000000000000000000191",
  "type": "contact.updated",
  "provider": "whatsapp",
  "account_id": "acc_example",
  "occurred_at": "2026-09-20T03:00:00Z",
  "data": {
    "contact": {
      "id": "15550000002@s.whatsapp.net",
      "conversation_id": "100000000000002@lid",
      "address_book": {
        "full_name": "Example customer",
        "first_name": "Example"
      }
    },
    "event": {
      "kind": "contact_updated",
      "source": "address_book",
      "changed_fields": ["address_book.full_name", "address_book.first_name"],
      "changed_at": "2026-09-20T03:00:00Z"
    }
  }
}

Notes

  • WhatsApp address-book names changed (not whatsapp-protocol). Update only supplied data.contact.address_book fields: empty strings clear values, omitted fields stay unchanged, and null is invalid. Does not overwrite nicknames or the account profile. contact.id identifies the contact resource, not necessarily a conversation.