Skip to main content
Use the Recommended Actions API to list an account’s actions, run a ready action, or dismiss it. A run sends each step in order, as the user who runs it. Retrieve the action to follow each step’s status.

Endpoints

Attributes

string
required
Recommended action ID, prefixed reca_.
string
required
The account the action is for, prefixed biz_.
string
required
When the action was created, as an ISO 8601 timestamp.
object | null
required
The website change the action makes when it runs. type picks the shape. New types can be added, so skip a preview whose type you do not know. null while the action is preparing, or when the action does not change a website.
string
required
Why Whop recommends the action, written for the account owner.
string | null
required
The user who ran the action, prefixed user_. null until the action runs.
string | null
required
When the run ended, as an ISO 8601 timestamp. null until the run ends.
string | null
required
When the run started, as an ISO 8601 timestamp. null until the action runs.
string
required
Where the action is. preparing while its work is built, and it cannot run yet. ready when it can run. running while its steps are sent. executed when every step succeeded. failed when the run ended before every step succeeded. dismissed when the owner chose not to run it. superseded when Whop retired it, such as for a newer action.Available options: preparing, ready, running, executed, failed, dismissed, superseded
string
required
What the action does, written for the account owner.
string
required
What kind of change the action makes. New values can be added, so skip an action whose type you do not know.Available options: add_cancel_offer, create_email_automation, improve_landing_page, fix_broken_website, clone_and_ab_test_site
string
required
When the action was last updated, as an ISO 8601 timestamp.
object | null
required
The API calls the action makes when it runs. null while the action is preparing, or when it has no steps.

Properties

string
required
The Api-Version-Date every step is sent with, such as 2026-11-14. The arguments of each step have the shape of this version.
object[]
required
The API calls the action makes when it runs, in the order they are sent.

Properties

object
required
The input of the operation under api_version. It holds the path, query and body parameters in one map. A value of the form \{\{steps[\<index>].\<field>}} reads a field from the response of an earlier step. \<index> is that step’s position in steps, counting from 0. The value is replaced before the step is sent.
string | null
required
Why the call did not go through. null when the step succeeded or was not sent.
string
required
The operationId of the API operation the step calls, such as createExperiment.
string
required
Where the step is in the run. pending until the run sends it. skipped means an earlier step failed, so this step was not sent.Available options: pending, running, succeeded, failed, skipped
string
required
One sentence for the account owner about what the step changes, such as Add a one-time wash button in the hero.
RecommendedAction