Skip to main content
POST
Initialize hubspot 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 HubSpot sandbox data structure (Flat Schema).

All object types are top-level lists. Relationships are defined via association fields in the respective objects (e.g. associated_company_names in HubSpotContact).

companies
HubSpotCompany · object[] | null

List of companies

contacts
HubSpotContact · object[] | null

List of contacts

deals
HubSpotDeal · object[] | null

List of deals

tickets
HubSpotTicket · object[] | null

List of tickets

tasks
HubSpotTask · object[] | null

List of tasks

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