Skip to main content
POST
Preview Automation Step

인증

Authorization
string
header
필수

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.

Scopes

automation:write
access_pass:basic:read
access_pass:stats:read
ad_campaign:basic:read
ad_campaign:read
ad_campaign:stats:read
ad_publisher:read
affiliate:basic:read
ai_chat:read
app_authorization:read
audience:basic:read
automation:read
bounty:basic:read
chat:read
checkout_configuration:basic:read
company:authorized_user:email:read
company:authorized_user:read
company:basic:read
company:log:read
company_token_transaction:read
course_analytics:read
course_lesson_interaction:read
courses:read
developer:logs:read
dms:read
domain:read
email:read
experience:hidden_experience:read
experiment:read
forum:read
identity:read
incorporation:read
invoice:basic:read
lead:basic:read
livestream:chat:read
media:read
member:basic:read
member:email:read
member:journey:read
member:payment_methods:read
member:phone:read
member:stats:read
partner:basic:read
partner:email:read
payment:basic:read
payment:dispute:read
payment:dispute_alert:read
payment:resolution_center_case:read
payment:setup_intent:read
plan:basic:read
plan:stats:read
plan:waitlist:read
promo_code:basic:read
referral:basic:read
shipment:basic:read
social_account:read
support_chat:read

헤더

Idempotency-Key
string

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

Maximum string length: 255
예시:

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

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

경로 매개변수

id
string
필수

Automation step ID, prefixed atos_.

본문

application/json
member_id
string
필수

The member to preview the step for, prefixed mber_.

예시:

"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.

예시:

"pay_xxxxxxxxxxxxxx"

응답

What the step would send

action_type
enum<string>
필수

The step's action type: email or message.

사용 가능한 옵션:
email,
message
예시:

"email"

html
string | null
필수

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.

예시:

"<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 marketing communications</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>
필수

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

사용 가능한 옵션:
sent,
skipped,
exited
예시:

"sent"

preheader
string | null
필수

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

예시:

null

reason
string | null
필수

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

예시:

null

subject
string | null
필수

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

예시:

"How's the kettle?"

text
string | null
필수

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.

예시:

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