Skip to main content
POST
Initialize resend sandbox with data

Authorizations

Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

sandbox_id
string
required

The unique sandbox identifier

Query Parameters

init_default_data
boolean
default:false

If true, use default test data for initialization

Body

application/json

Complete Resend sandbox data structure.

Mixed structure:

  • Segments contain nested Broadcasts (broadcasts MUST have a segment)
  • Emails are standalone (transactional)
  • Contacts are standalone (can be optionally linked to segments)
emails
ResendEmail · object[] | null

List of standalone transactional emails

contacts
ResendContact · object[] | null

List of standalone contacts

segments
ResendSegment · object[] | null

List of segments with nested broadcasts

Response

Successful Response

Response model for sandbox initialization

sandbox_id
string
required

Sandbox identifier

status
enum<string>
required

Current status

Available options:
idle,
occupied,
error
message
string
required

Initialization result message