User preferences webhoooks

WhatsApp users can use the Offers and announcements setting to stop or resume marketing template messages from individual businesses. See the following documents to learn more about this setting:

• Cloud API: User preferences for marketing messages
• On-Premises API: User preferences for marketing messages

Trigger events

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

Cloud API Syntax

{
  "object": "whatsapp_business_account",
  "entry": [{
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [{
          "value": {
             "messaging_product": "whatsapp",
             "metadata": {
               "display_phone_number": "<BUSINESS_PHONE_NUMBER>",
               "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
             },
             "contacts": [
              {
                "profile": {
                  "name": "<WHATSAPP_USER_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>"
              }
             ],
             "user_preferences": [{
                  "wa_id": "<WHATSAPP_USER_PHONE_NUMBER>",
                  "detail": "<PREFERENCE_DESCRIPTION>",
                  "category" : "marketing_messages",
                  "value" : "<PREFERENCE>"
                  "timestamp": <WEBHOOK_SENT_TIMESTAMP>,
                }]
          },
          "field": "user_preferences"
        }]
    }]
}

Cloud API Parameters

On-Premises API Syntax

{
  "contacts": [
    {
      "profile": {
        "name": "<WHATSAPP_USER_NAME>"
      },
      "wa_id": "<WHATSAPP_USER_ID>"
    }
  ],
  "messages": [
    {
      "from": "<WHATSAPP_USER_PHONE_NUMBER>",
      "id": "<WHATSAPP_MESSAGE_ID>",
      "system": {
        "body": "<PREFERENCE_DESCRIPTION>",
        "marketing": "<PREFERENCE>",
        "type": "user_preference_changed"
      },
      "timestamp": <WEBHOOK_SENT_TIMESTAMP>,
      "type": "system"
    }
  ]
}

On-Premises API Parameters