Skip to main content
POST
/
api
/
public
/
v1
/
funnels
/
{funnelId}
/
preview-session
Create a preview session
curl --request POST \
  --url https://app.localhost:3000/api/public/v1/funnels/{funnelId}/preview-session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "storeId": "store_123",
  "funnelId": "funnelv2_123",
  "stepId": "step_thankyou",
  "accountId": "acc_123",
  "contextData": {
    "orderId": "order_abc123"
  }
}
'
{
  "sessionId": "fs_123456789",
  "funnelId": "funnelv2_123",
  "stepId": "step_thankyou",
  "token": "eyJhbG...",
  "customerId": "cus_preview_123"
}

Authorizations

​
Authorization
string
header
required

Enter your API key as: Bearer your-api-key

Path Parameters

​
funnelId
string
required

Body

application/json
​
storeId
string
required
​
stepId
string
required
​
builderOptions
object
​
environment
enum<string>
default:staging
Available options:
staging,
production
​
funnelVariantId
string
​
enableSticky
boolean
​
currency
string
​
locale
string
​
testCardPreset
enum<string>
Available options:
visa_success,
mastercard_success,
amex_success,
visa_declined,
visa_insufficient,
visa_3ds
​
previewShippingCountry
string
Required string length: 2

Response

Successful response