---
title: "POST /api/v1/onboarding.session.insert"
method: POST
path: "/api/v1/onboarding.session.insert"
tags: ["Onboarding V2"]
---

# POST /api/v1/onboarding.session.insert

`POST /api/v1/onboarding.session.insert`

## Request

- Base URL: `https://api.partly.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.partly.com/api/v1/onboarding.session.insert`
- Auth: none declared

Create an onboarding session for a form

## Request body

- OnboardingSessionInsertRequest
  - `form_name` 'nz-workshop-v1', required
  - `hubspot_challenge` string: UTF-8 encoded string
  - `hubspot_deal_id` string: UTF-8 encoded string
  - `organization_name` string, required: UTF-8 encoded string
  - `recipient_emails` StdStringString[], required: Expandable array type

## Response `200`

200 OK

- OnboardingSessionInsertResponse
  - `session_id` string, uuid, required: UUID value type

## Other responses

- `default`: Error cases

## Changes

- **2026-10-19** `0060854f7c86`: 2 info
  - the request property `hubspot_challenge` became optional
  - the request property `hubspot_deal_id` became optional
- **2026-10-15** `d73948080dc7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/partly/apis/core-server/changes/api/v1/onboarding.session.insert/post.md)

---

[API](https://skmtc.dev/partly/apis/core-server.md) · [All operations](https://skmtc.dev/partly/apis/core-server/llms.txt) · [OpenAPI document](https://skmtc.dev/partly/apis/core-server/revisions/19dd5c84162b?raw)