Skip to main content
POST
Preview Automation Step

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, or an account-scoped user token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

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-05-1"

Path Parameters

id
string
required

Automation step ID, prefixed atos_.

Body

application/json
member_id
string
required

The member to preview the step for, prefixed mber_.

Example:

"mber_xxxxxxxxxxxxxx"

trigger_resource_id
string | null

ID of the record the automation's trigger event was about for this member, such as a pay_ payment.

Example:

"pay_xxxxxxxxxxxxxx"

Response

What the step would send

action_type
enum<string>
required

The step's action type: email or message.

Available options:
email,
message
Example:

"email"

html
string | null
required

The email's HTML, with Whop's footer. Its unsubscribe link is a placeholder until the email is sent. null unless an email step sends.

Example:

"<html><body><p>Hi there</p><table role=\"presentation\" data-whop-footer width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"margin:32px 0 0;border-top:1px solid #e6e6e6;\">\n<tr><td style=\"padding:20px 16px;text-align:center;font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Helvetica,Arial,sans-serif;font-size:12px;line-height:18px;color:#6f6f6f;\">\n<p style=\"margin:0 0 8px;\">You&#39;re receiving this because you bought from Batman1. <a href=\"{{whop_unsubscribe_url}}\" style=\"color:#6f6f6f;text-decoration:underline;\">Unsubscribe from Batman1 emails</a>.</p>\n<p style=\"margin:0 0 8px;\">Problem with your order? <a href=\"https://whop.com/@me/settings/resolution-center/\" style=\"color:#6f6f6f;text-decoration:underline;\">Open a case in the Resolution Center</a>.</p>\n<p style=\"margin:0;font-weight:600;color:#9a9a9a;\">Sent with Whop</p>\n<!--whop:open-pixel-->\n</td></tr>\n</table>\n\n</body></html>"

outcome
enum<string>
required

What the step does for this member: sent its message, skipped it and moved on to the next step, or exited the automation.

Available options:
sent,
skipped,
exited
Example:

"sent"

preheader
string | null
required

The inbox preview line after the subject. null when the email has none.

Example:

null

reason
string | null
required

Why the step skipped or exited, as the step's code said. null when it sends or gave no reason.

Example:

null

subject
string | null
required

The email's subject. null unless an email step sends.

Example:

"How's the kettle?"

text
string | null
required

The message as plain text: the message on a message step, or the email's plain-text version with Whop's footer. null unless the step sends.

Example:

"Hi there\n\n--\nYou're receiving this because you bought from Batman1. Unsubscribe from Batman1 emails: {{whop_unsubscribe_url}}\nProblem with your order? Open a case in the Resolution Center: https://whop.com/@me/settings/resolution-center/\nSent with Whop"