Skip to main content
POST
Execute Recommended Action

Authorizations

Authorization
string
header
required

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

company:basic:read

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-11-17-3"

Path Parameters

id
string
required

Recommended action ID, prefixed reca_.

Example:

"reca_xxxxxxxxxxxxx"

Response

Run started

account_id
string
required

The account the action is for, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

created_at
string
required

When the action was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

id
string
required

Recommended action ID, prefixed reca_.

Example:

"reca_xxxxxxxxxxxxxx"

preview
object
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.

reasoning
string
required

Why Whop recommends the action, written for the account owner.

Example:

"Visitors who reach your pricing section buy, but most leave the home page before they scroll to it."

run_by_user_id
string | null
required

The user who ran the action, prefixed user_. null until the action runs.

Example:

"user_xxxxxxxxxxxxxx"

run_ended_at
string | null
required

When the run ended, as an ISO 8601 timestamp. null until the run ends.

Example:

null

run_started_at
string | null
required

When the run started, as an ISO 8601 timestamp. null until the action runs.

Example:

"2026-01-01T12:00:00.000Z"

status
enum<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
Example:

"running"

title
string
required

What the action does, written for the account owner.

Example:

"Lead your home page with member results"

type
enum<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
Example:

"improve_landing_page"

updated_at
string
required

When the action was last updated, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

workflow
object | null
required

The API calls the action makes when it runs. null while the action is preparing, or when it has no steps.