Skip to main content

user_preferences webhook reference | Developer Documentation

user_preferences webhook reference

Updated: Nov 5, 2025
This reference describes trigger events and payload contents for the WhatsApp Business Account user_preferences webhook.
The user_preferences webhook notifies you of changes to a WhatsApp user's marketing message preferences.

Triggers

    A WhatsApp user stops marketing messages.A WhatsApp user resumes marketing messages.

    Parameters

    Placeholder Description Example value
    <BUSINESS_DISPLAY_PHONE_NUMBER>
    String
    Business display phone number.
    15550783881
    <BUSINESS_PHONE_NUMBER_ID>
    String
    Business phone number ID.
    106540352242922
    <PREFERENCE>
    String
    Values can be:
    stop - Indicates the WhatsApp user has opted to stop receiving marketing messages from you.
    resume - Indicates the WhatsApp user has opted to resume receiving marketing messages from you.
    stop
    <PREFERENCE_DESCRIPTION>
    String
    Values can be:
      User requested to stop marketing messagesUser requested to resume marketing messages
      User requested to stop marketing messages
      <WEBHOOK_TRIGGER_TIMESTAMP>
      Integer
      Unix timestamp indicating when the webhook was triggered.
      1739321024
      <WHATSAPP_BUSINESS_ACCOUNT_ID>
      String
      WhatsApp Business Account ID.
      102290129340398
      <WHATSAPP_USER_ID>
      String
      WhatsApp user ID. Note that a WhatsApp user's ID and phone number may not always match.
      16505551234
      <WHATSAPP_USER_PROFILE_NAME>
      String
      WhatsApp user's name as it appears in their profile in the WhatsApp client.
      Sheena Nelson
      Back to top