Troubleshoot

Fixing SCREEN_ID_IS_RESERVED_KEYWORD: Don’t Use success as a Screen ID

If you're seeing the SCREEN_ID_IS_RESERVED_KEYWORD error, here's the fix right up front:

Don’t use a reserved keyword a screen ID. Pick a different, unique name.

Why This Happens

In platforms that use JSON-based flow definitions, some keywords are reserved for internal logic. One of these is success. It plays a special role during the data_exchange action. When a backend call returns with a success response, the platform looks for a screen with ID success to route to by default.

So, if you try to name your screen like this:

{
  "id": "success",
  ...
}

you’ll get the SCREEN_ID_IS_RESERVED_KEYWORD error.

How to Fix It

Just rename the screen to anything that’s not a reserved keyword. For example:

{
  "id": "paymentSuccess",
  ...
}
or
{
  "id": "orderConfirmed",
  ...
}

Avoid common reserved terms like success, error, default, or fallback unless you're intentionally working with flow routing logic.

TL;DR

Avoiding reserved keywords helps your flow run smoothly and keeps platform errors out of your way.

Book a Demo

Get in touch with our CEO for all your WhatsApp API needs!

Heltar

Automate WhatsApp for Businesses! Heltar is a growth engine for everyone. we help you with Bulk Messaging at scale, AI Agents and Workflow Automations; Team Inbox for all your agents, and Voice Agents cross-functionally with WhatsApp capabilities.