If you're working with WhatsApp API flows and encounter the INVALID_PROPERTY_VALUE error stating:

"At least one terminal screen must have property 'success' set as true."

it means your flow's terminal screens are missing a required configuration. Here’s how to fix it.

Understanding the Error

In WhatsApp interactive flows, a terminal screen is a final step where the conversation ends. These screens need a 'success' property that indicates whether the interaction ended with a positive business outcome.

If none of your terminal screens have "success": true, the flow will fail with an INVALID_PROPERTY_VALUE error.

How to Fix It

  1. Locate Terminal Screens:

    • Identify all screens in your flow where the conversation terminates.

    • These are marked with "terminal": true in the JSON configuration.

  2. Ensure One Terminal Screen Has 'success' Set to True:

    • Modify at least one terminal screen to include "success": true.

Example Fix:

Incorrect Configuration (Causing Error)

{
  "version": "2.1",
  "screens": [
    {
      "terminal": true,
      "success": false
    }
  ]
}

Corrected Configuration

{
  "version": "2.1",
  "screens": [
    {
      "terminal": true,
      "success": true
    }
  ]
}

Tips to Debug and Prevent Schema Errors​

  • Review the official documentation to understand property constraints.
  • Use a JSON schema validator to catch errors early.
  • Ensure properties are placed in the correct hierarchy.
  • If using a coding environment, enable JSON linting.
  • Ensure the structure follows API requirements.​

For more troubleshooting insights related to WhatsApp Business API, check out heltar.com/blogs.