Skip to main content
POST
/
sandbox
/
hubspot
/
{sandbox_id}
/
initialize
Initialize hubspot sandbox with data
curl --request POST \
  --url https://api.klavis.ai/sandbox/hubspot/{sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companies": [
    {
      "name": "<string>",
      "domain": "<string>",
      "industry": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "phone": "<string>",
      "number_of_employees": "<string>",
      "annual_revenue": "<string>"
    }
  ],
  "contacts": [
    {
      "firstname": "<string>",
      "lastname": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "job_title": "<string>"
    }
  ],
  "deals": [
    {
      "deal_name": "<string>",
      "amount": "<string>",
      "deal_stage": "<string>",
      "pipeline": "<string>",
      "close_date": "<string>"
    }
  ],
  "tickets": [
    {
      "subject": "<string>",
      "content": "<string>",
      "pipeline": "<string>",
      "pipeline_stage": "<string>",
      "priority": "<string>"
    }
  ],
  "tasks": [
    {
      "subject": "<string>",
      "body": "<string>",
      "status": "<string>",
      "priority": "<string>",
      "due_date": "<string>"
    }
  ]
}
'
{
  "sandbox_id": "<string>",
  "status": "idle",
  "message": "<string>",
  "records_created": {}
}

Authorizations

Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

sandbox_id
string
required

The unique sandbox identifier

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
message
string
required

Initialization result message

records_created
Records Created · object

Count of records created per object type