> ## Documentation Index
> Fetch the complete documentation index at: https://www.klavis.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Initialize hubspot sandbox with data

> Initialize the sandbox with hubspot-specific data following the defined schema.



## OpenAPI

````yaml post /sandbox/hubspot/{sandbox_id}/initialize
openapi: 3.1.0
info:
  title: Klavis AI (https://www.klavis.ai)
  description: Klavis AI - Open Source MCP Integrations for AI Applications
  version: 0.1.0
servers:
  - url: https://api.klavis.ai
    description: US Production server
  - url: https://api.eu.klavis.ai
    description: EU Production server
security: []
paths:
  /sandbox/hubspot/{sandbox_id}/initialize:
    post:
      tags:
        - sandbox
      summary: Initialize hubspot sandbox with data
      description: >-
        Initialize the sandbox with hubspot-specific data following the defined
        schema.
      operationId: initialize_sandbox_sandbox_hubspot__sandbox_id__initialize_post
      parameters:
        - name: sandbox_id
          in: path
          required: true
          schema:
            type: string
            description: The unique sandbox identifier
            title: Sandbox Id
          description: The unique sandbox identifier
        - name: init_default_data
          in: query
          required: false
          schema:
            type: boolean
            description: If true, use default test data for initialization
            default: false
            title: Init Default Data
          description: If true, use default test data for initialization
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/HubSpotData-Input'
                - type: 'null'
              title: Request Body
            examples:
              default:
                summary: Example initialization data
                value:
                  companies:
                    - company_name: TechCorp Solutions
                      website_domain: techcorp.com
                      industry: COMPUTER_SOFTWARE
                      city: San Francisco
                      state_region: CA
                      country: United States
                      phone_number: +1-415-555-0101
                      employee_count: '250'
                      yearly_revenue: '15000000'
                    - company_name: DataFlow Analytics
                      website_domain: dataflow-analytics.com
                      industry: INFORMATION_TECHNOLOGY_AND_SERVICES
                      city: Austin
                      state_region: TX
                      country: United States
                      phone_number: +1-512-555-0201
                      employee_count: '75'
                      yearly_revenue: '5000000'
                    - company_name: CloudScale Inc
                      website_domain: cloudscale.io
                      industry: INTERNET
                      city: Seattle
                      state_region: WA
                      country: United States
                      phone_number: +1-206-555-0301
                      employee_count: '500'
                      yearly_revenue: '45000000'
                  contacts:
                    - first_name: John
                      last_name: Smith
                      email_address: john.smith@techcorp.com
                      phone_number: +1-415-555-0102
                      job_title: CTO
                    - first_name: Sarah
                      last_name: Johnson
                      email_address: sarah.johnson@techcorp.com
                      phone_number: +1-415-555-0103
                      job_title: VP of Engineering
                    - first_name: Michael
                      last_name: Chen
                      email_address: michael.chen@techcorp.com
                      phone_number: +1-415-555-0104
                      job_title: Product Manager
                    - first_name: Emily
                      last_name: Rodriguez
                      email_address: emily@dataflow-analytics.com
                      phone_number: +1-512-555-0202
                      job_title: CEO
                    - first_name: David
                      last_name: Kim
                      email_address: david@dataflow-analytics.com
                      phone_number: +1-512-555-0203
                      job_title: Data Architect
                    - first_name: Jennifer
                      last_name: Williams
                      email_address: jennifer@cloudscale.io
                      phone_number: +1-206-555-0302
                      job_title: Head of Operations
                    - first_name: Alex
                      last_name: Thompson
                      email_address: alex.thompson@freelancer.com
                      phone_number: +1-555-0401
                      job_title: Independent Consultant
                    - first_name: Maria
                      last_name: Garcia
                      email_address: maria.garcia@startup.com
                      phone_number: +1-555-0402
                      job_title: Founder
                  deals:
                    - title: Enterprise License Agreement
                      value: '150000'
                      stage: contractsent
                      pipeline: default
                      expected_close_date: '2024-03-15T00:00:00Z'
                    - title: Professional Services Package
                      value: '50000'
                      stage: qualifiedtobuy
                      pipeline: default
                      expected_close_date: '2024-04-01T00:00:00Z'
                    - title: Annual Platform Subscription
                      value: '200000'
                      stage: decisionmakerboughtin
                      pipeline: default
                      expected_close_date: '2024-02-28T00:00:00Z'
                    - title: Starter Package
                      value: '25000'
                      stage: presentationscheduled
                      pipeline: default
                      expected_close_date: '2024-03-30T00:00:00Z'
                    - title: Multi-year Enterprise Deal
                      value: '500000'
                      stage: appointmentscheduled
                      pipeline: default
                      expected_close_date: '2024-05-15T00:00:00Z'
                    - title: Consulting Engagement
                      value: '75000'
                      stage: qualifiedtobuy
                      pipeline: default
                      expected_close_date: '2024-03-20T00:00:00Z'
                    - title: Individual License
                      value: '5000'
                      stage: qualifiedtobuy
                      pipeline: default
                      expected_close_date: '2024-02-28T00:00:00Z'
                    - title: Partnership Opportunity
                      value: '100000'
                      stage: qualifiedtobuy
                      pipeline: default
                      expected_close_date: '2024-04-30T00:00:00Z'
                  tickets:
                    - title: API integration question
                      description: Need clarification on webhook authentication
                      pipeline: '0'
                      workflow_stage: '1'
                      priority_level: MEDIUM
                    - title: 'Feature request: SSO integration'
                      description: Request for SAML-based single sign-on capability
                      pipeline: '0'
                      workflow_stage: '1'
                      priority_level: HIGH
                    - title: Data export format question
                      description: >-
                        Need to understand available export formats and
                        scheduling options
                      pipeline: '0'
                      workflow_stage: '1'
                      priority_level: LOW
                    - title: Billing question
                      description: Question about payment options and invoicing
                      pipeline: '0'
                      workflow_stage: '1'
                      priority_level: LOW
                    - title: Startup program inquiry
                      description: Interested in joining startup accelerator program
                      pipeline: '0'
                      workflow_stage: '1'
                      priority_level: MEDIUM
                    - title: General inquiry from website
                      description: Visitor submitted question through contact form
                      pipeline: '0'
                      workflow_stage: '1'
                      priority_level: LOW
                  tasks:
                    - title: Follow up on contract review
                      description: Check if legal team has finished reviewing the contract
                      task_status: IN_PROGRESS
                      priority_level: HIGH
                      deadline: '2024-02-20T17:00:00Z'
                    - title: Schedule implementation call
                      description: Set up kick-off meeting with implementation team
                      task_status: NOT_STARTED
                      priority_level: MEDIUM
                      deadline: '2024-03-01T10:00:00Z'
                    - title: Prepare custom proposal
                      description: >-
                        Create tailored services proposal based on discovery
                        call
                      task_status: IN_PROGRESS
                      priority_level: HIGH
                      deadline: '2024-02-18T17:00:00Z'
                    - title: Research webhook authentication options
                      description: Document different authentication methods available
                      task_status: COMPLETED
                      priority_level: MEDIUM
                      deadline: '2024-02-15T12:00:00Z'
                    - title: Send quarterly business review invitation
                      description: Schedule QBR meeting for Q1 2024
                      task_status: NOT_STARTED
                      priority_level: MEDIUM
                      deadline: '2024-03-01T09:00:00Z'
                    - title: Evaluate SSO requirements
                      description: Gather detailed requirements from customer
                      task_status: IN_PROGRESS
                      priority_level: HIGH
                      deadline: '2024-02-22T17:00:00Z'
                    - title: Create SSO implementation estimate
                      task_status: NOT_STARTED
                      priority_level: MEDIUM
                      deadline: '2024-02-25T17:00:00Z'
                    - title: Schedule product demo
                      description: Demo new features to TechCorp team
                      task_status: NOT_STARTED
                      priority_level: HIGH
                      deadline: '2024-02-28T14:00:00Z'
                    - title: Prepare pricing options
                      description: Create tiered pricing proposal with volume discounts
                      task_status: COMPLETED
                      priority_level: HIGH
                      deadline: '2024-02-10T17:00:00Z'
                    - title: Coordinate with finance team
                      description: Ensure invoicing and payment terms are set up
                      task_status: IN_PROGRESS
                      priority_level: MEDIUM
                      deadline: '2024-02-25T12:00:00Z'
                    - title: Prepare demo presentation
                      description: Customize demo to show analytics-specific features
                      task_status: IN_PROGRESS
                      priority_level: HIGH
                      deadline: '2024-02-19T15:00:00Z'
                    - title: Send case study documents
                      description: Share relevant customer success stories
                      task_status: NOT_STARTED
                      priority_level: MEDIUM
                      deadline: '2024-02-20T10:00:00Z'
                    - title: Schedule C-level meeting
                      description: Arrange meeting with CEO and CFO
                      task_status: IN_PROGRESS
                      priority_level: HIGH
                      deadline: '2024-02-21T16:00:00Z'
                    - title: Prepare ROI analysis
                      description: Build comprehensive ROI model for 3-year contract
                      task_status: NOT_STARTED
                      priority_level: HIGH
                      deadline: '2024-02-27T17:00:00Z'
                    - title: Draft statement of work
                      description: Create detailed SOW for consulting services
                      task_status: IN_PROGRESS
                      priority_level: HIGH
                      deadline: '2024-02-23T17:00:00Z'
                    - title: Send license agreement
                      task_status: NOT_STARTED
                      priority_level: MEDIUM
                      deadline: '2024-02-17T12:00:00Z'
                    - title: Review startup program eligibility
                      description: Check if company meets program criteria
                      task_status: IN_PROGRESS
                      priority_level: MEDIUM
                      deadline: '2024-02-19T17:00:00Z'
                    - title: Send startup program information
                      description: Share details about benefits and application process
                      task_status: NOT_STARTED
                      priority_level: HIGH
                      deadline: '2024-02-20T11:00:00Z'
                    - title: Research potential partner
                      description: Gather information about partnership fit and objectives
                      task_status: IN_PROGRESS
                      priority_level: MEDIUM
                      deadline: '2024-02-25T17:00:00Z'
                    - title: Respond to inquiry
                      description: Provide initial response and gather more details
                      task_status: NOT_STARTED
                      priority_level: LOW
                      deadline: '2024-02-18T17:00:00Z'
                    - title: Weekly team standup
                      description: Regular sync meeting with sales team
                      task_status: NOT_STARTED
                      priority_level: MEDIUM
                      deadline: '2024-02-19T10:00:00Z'
                    - title: Update CRM data quality
                      description: Review and clean up duplicate records
                      task_status: IN_PROGRESS
                      priority_level: LOW
                      deadline: '2024-02-29T17:00:00Z'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitializeSandboxResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    HubSpotData-Input:
      properties:
        companies:
          anyOf:
            - items:
                $ref: '#/components/schemas/HubSpotCompany-Input'
              type: array
            - type: 'null'
          title: Companies
          description: List of companies
        contacts:
          anyOf:
            - items:
                $ref: '#/components/schemas/HubSpotContact-Input'
              type: array
            - type: 'null'
          title: Contacts
          description: List of contacts
        deals:
          anyOf:
            - items:
                $ref: '#/components/schemas/HubSpotDeal-Input'
              type: array
            - type: 'null'
          title: Deals
          description: List of deals
        tickets:
          anyOf:
            - items:
                $ref: '#/components/schemas/HubSpotTicket-Input'
              type: array
            - type: 'null'
          title: Tickets
          description: List of tickets
        tasks:
          anyOf:
            - items:
                $ref: '#/components/schemas/HubSpotTask-Input'
              type: array
            - type: 'null'
          title: Tasks
          description: List of tasks
      type: object
      title: HubSpotData
      description: >-
        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).
    InitializeSandboxResponse:
      properties:
        sandbox_id:
          type: string
          title: Sandbox Id
          description: Sandbox identifier
        status:
          $ref: '#/components/schemas/SandboxStatus'
          description: Current status
        message:
          type: string
          title: Message
          description: Initialization result message
      type: object
      required:
        - sandbox_id
        - status
        - message
      title: InitializeSandboxResponse
      description: Response model for sandbox initialization
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    HubSpotCompany-Input:
      properties:
        company_name:
          type: string
          title: Company Name
          description: Company name
        website_domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Website Domain
          description: Company website domain
        industry:
          anyOf:
            - type: string
            - type: 'null'
          title: Industry
          description: Company industry
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
          description: Company city
        state_region:
          anyOf:
            - type: string
            - type: 'null'
          title: State Region
          description: Company state/region
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
          description: Company country
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone Number
          description: Company phone number
        employee_count:
          anyOf:
            - type: string
            - type: 'null'
          title: Employee Count
          description: Number of employees
        yearly_revenue:
          anyOf:
            - type: string
            - type: 'null'
          title: Yearly Revenue
          description: Yearly revenue
      type: object
      required:
        - company_name
      title: HubSpotCompany
      description: >-
        HubSpot Company object.

        Base object, typically doesn't associate upwards in this schema, but
        contacts/deals associate to it.
    HubSpotContact-Input:
      properties:
        first_name:
          type: string
          title: First Name
          description: Contact first name
        last_name:
          type: string
          title: Last Name
          description: Contact last name
        email_address:
          type: string
          title: Email Address
          description: Contact email address
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone Number
          description: Contact phone number
        job_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Job Title
          description: Contact job title
      type: object
      required:
        - first_name
        - last_name
        - email_address
      title: HubSpotContact
      description: |-
        HubSpot Contact object.
        Can be associated with: Companies.
    HubSpotDeal-Input:
      properties:
        title:
          type: string
          title: Title
          description: Deal title
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
          description: Deal value/amount
        stage:
          anyOf:
            - type: string
            - type: 'null'
          title: Stage
          description: Deal stage
        pipeline:
          anyOf:
            - type: string
            - type: 'null'
          title: Pipeline
          description: Deal pipeline
        expected_close_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Expected Close Date
          description: Expected close date
      type: object
      required:
        - title
      title: HubSpotDeal
      description: |-
        HubSpot Deal object.
        Can be associated with: Contacts, Companies.
    HubSpotTicket-Input:
      properties:
        title:
          type: string
          title: Title
          description: Ticket title
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Ticket description/details
        pipeline:
          anyOf:
            - type: string
            - type: 'null'
          title: Pipeline
          description: Ticket pipeline
        workflow_stage:
          anyOf:
            - type: string
            - type: 'null'
          title: Workflow Stage
          description: Ticket workflow stage
        priority_level:
          anyOf:
            - type: string
            - type: 'null'
          title: Priority Level
          description: Ticket priority (HIGH, MEDIUM, LOW)
      type: object
      required:
        - title
      title: HubSpotTicket
      description: |-
        HubSpot Ticket object.
        Can be associated with: Contacts, Companies.
    HubSpotTask-Input:
      properties:
        title:
          type: string
          title: Title
          description: Task title
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Task description/details
        task_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Task Status
          description: Task status (NOT_STARTED, IN_PROGRESS, COMPLETED, WAITING, DEFERRED)
        priority_level:
          anyOf:
            - type: string
            - type: 'null'
          title: Priority Level
          description: Task priority (HIGH, MEDIUM, LOW)
        deadline:
          anyOf:
            - type: string
            - type: 'null'
          title: Deadline
          description: Task deadline (ISO 8601 format)
      type: object
      required:
        - title
      title: HubSpotTask
      description: |-
        HubSpot Task object.
        Can be associated with: Contacts, Companies, Deals, Tickets.
    SandboxStatus:
      type: string
      enum:
        - idle
        - occupied
        - error
      title: SandboxStatus
      description: Status of a sandbox instance - matches database enum
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      description: Your Klavis AI API key.
      scheme: bearer
      x-fern-bearer:
        name: api_key

````