> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pivotal.app/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pivotal.app/_mcp/server.

# Create an onboarding

POST https://my.pivotal.app/api/v1/onboardings
Content-Type: application/json

Defaults: phase=before_getting_started, state=active, reminders on, frequency 1 day.

Reference: https://docs.pivotal.app/api/reference/pivotal-api/onboardings/create-onboarding

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: openapi
  version: 1.0.0
paths:
  /api/v1/onboardings:
    post:
      operationId: create-onboarding
      summary: Create an onboarding
      description: >-
        Defaults: phase=before_getting_started, state=active, reminders on,
        frequency 1 day.
      tags:
        - subpackage_onboardings
      parameters:
        - name: Authorization
          in: header
          description: |
            Send your key in the `Authorization` header. Keys start with
            `pivotal_` (production) or `pivotal_test_` (test mode, no side
            effects on integrations). Rotate keys from
            `/admin/api-keys` — old keys 401 instantly when revoked.
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Onboarding'
        '400':
          description: Invalid request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Customer not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardingCreate'
servers:
  - url: https://my.pivotal.app
    description: Production
components:
  schemas:
    OnboardingCreatePhase:
      type: string
      enum:
        - before_getting_started
        - program_design
        - review
        - program_buildout
        - internal_qa
        - launch
        - completed
      title: OnboardingCreatePhase
    OnboardingCreateState:
      type: string
      enum:
        - active
        - paused
        - at_risk
        - waiting
      title: OnboardingCreateState
    OnboardingCreate:
      type: object
      properties:
        customer_id:
          type: string
          description: Numeric display_id or cuid of the parent customer.
        template_id:
          type: string
        phase:
          $ref: '#/components/schemas/OnboardingCreatePhase'
        state:
          $ref: '#/components/schemas/OnboardingCreateState'
        target_launch_date:
          type: string
          format: date-time
        csm_id:
          type:
            - string
            - 'null'
        se_id:
          type:
            - string
            - 'null'
        designer_id:
          type:
            - string
            - 'null'
        product_ops_id:
          type:
            - string
            - 'null'
        notes:
          type: string
        reminder_email:
          type: boolean
        reminder_slack:
          type: boolean
        reminder_frequency_days:
          type: integer
      required:
        - customer_id
      title: OnboardingCreate
    OnboardingObject:
      type: string
      enum:
        - onboarding
      title: OnboardingObject
    OnboardingPhase:
      type: string
      enum:
        - before_getting_started
        - program_design
        - review
        - program_buildout
        - internal_qa
        - launch
        - completed
      title: OnboardingPhase
    OnboardingState:
      type: string
      enum:
        - active
        - paused
        - at_risk
        - waiting
      title: OnboardingState
    Onboarding:
      type: object
      properties:
        object:
          $ref: '#/components/schemas/OnboardingObject'
        id:
          type: string
        display_id:
          type: integer
        customer_id:
          type: string
        template_id:
          type:
            - string
            - 'null'
        phase:
          $ref: '#/components/schemas/OnboardingPhase'
        state:
          $ref: '#/components/schemas/OnboardingState'
        started_at:
          type: string
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
        target_launch_date:
          type:
            - string
            - 'null'
          format: date-time
        csm_id:
          type:
            - string
            - 'null'
        se_id:
          type:
            - string
            - 'null'
        designer_id:
          type:
            - string
            - 'null'
        product_ops_id:
          type:
            - string
            - 'null'
        notes:
          type:
            - string
            - 'null'
        waiting_on_customer:
          type: boolean
        waiting_on_customer_since:
          type:
            - string
            - 'null'
          format: date-time
        wizard_completed_at:
          type:
            - string
            - 'null'
          format: date-time
        reminder_email:
          type: boolean
        reminder_slack:
          type: boolean
        reminder_frequency_days:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - object
        - id
        - display_id
        - customer_id
        - template_id
        - phase
        - state
        - started_at
        - completed_at
        - target_launch_date
        - csm_id
        - se_id
        - designer_id
        - product_ops_id
        - notes
        - waiting_on_customer
        - waiting_on_customer_since
        - wizard_completed_at
        - reminder_email
        - reminder_slack
        - reminder_frequency_days
        - created_at
        - updated_at
      title: Onboarding
    ErrorErrorType:
      type: string
      enum:
        - invalid_request_error
        - authentication_error
        - permission_error
        - rate_limit_error
        - not_found
        - conflict
        - internal_error
      title: ErrorErrorType
    ErrorError:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ErrorErrorType'
        code:
          type: string
        message:
          type: string
        field:
          type: string
      required:
        - type
        - code
        - message
      title: ErrorError
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorError'
      required:
        - error
      title: Error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: |
        Send your key in the `Authorization` header. Keys start with
        `pivotal_` (production) or `pivotal_test_` (test mode, no side
        effects on integrations). Rotate keys from
        `/admin/api-keys` — old keys 401 instantly when revoked.

```

## Examples



**Request**

```json
{
  "customer_id": "cust_987654321"
}
```

**Response**

```json
{
  "object": "onboarding",
  "id": "onb_123456789abcdef",
  "display_id": 1024,
  "customer_id": "cust_987654321",
  "template_id": "tmpl_abc123xyz",
  "phase": "before_getting_started",
  "state": "active",
  "started_at": "2024-04-01T08:00:00Z",
  "completed_at": "2024-04-15T17:00:00Z",
  "target_launch_date": "2024-05-01T09:00:00Z",
  "csm_id": "user_csm_001",
  "se_id": "user_se_002",
  "designer_id": "user_designer_003",
  "product_ops_id": "user_ops_004",
  "notes": "Initial onboarding phase started. Awaiting customer feedback on program design.",
  "waiting_on_customer": true,
  "waiting_on_customer_since": "2024-04-10T12:00:00Z",
  "wizard_completed_at": "2024-04-05T15:30:00Z",
  "reminder_email": true,
  "reminder_slack": true,
  "reminder_frequency_days": 1,
  "created_at": "2024-04-01T07:55:00Z",
  "updated_at": "2024-04-12T10:20:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://my.pivotal.app/api/v1/onboardings"

payload = { "customer_id": "cust_987654321" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://my.pivotal.app/api/v1/onboardings';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"customer_id":"cust_987654321"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://my.pivotal.app/api/v1/onboardings"

	payload := strings.NewReader("{\n  \"customer_id\": \"cust_987654321\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://my.pivotal.app/api/v1/onboardings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"cust_987654321\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://my.pivotal.app/api/v1/onboardings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"cust_987654321\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://my.pivotal.app/api/v1/onboardings', [
  'body' => '{
  "customer_id": "cust_987654321"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://my.pivotal.app/api/v1/onboardings");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"customer_id\": \"cust_987654321\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["customer_id": "cust_987654321"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://my.pivotal.app/api/v1/onboardings")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```