For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DashboardGet an API key
Get StartedGuidesAPI ReferenceSDKsChangelog
Get StartedGuidesAPI ReferenceSDKsChangelog
  • Meta
    • GETGet current identity
    • GETLiveness probe
  • Customers
    • GETList customers
    • POSTCreate a customer
    • GETRetrieve a customer
    • DELDelete a customer
    • PATCHUpdate a customer
  • Contacts
    • GETList a customer's contacts
    • POSTAdd a contact to a customer
    • GETRetrieve a contact
    • DELDelete a contact
    • PATCHUpdate a contact
  • Onboardings
    • GETList onboardings
    • POSTCreate an onboarding
    • GETList a customer's onboardings
    • GETRetrieve an onboarding
    • DELDelete an onboarding
    • PATCHUpdate an onboarding
LogoLogo
DashboardGet an API key
Onboardings

Create an onboarding

|View as Markdown|Open in Claude|
POST
https://my.pivotal.app/api/v1/onboardings
POST
/api/v1/onboardings
1const url = 'https://my.pivotal.app/api/v1/onboardings';
2const options = {
3  method: 'POST',
4  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5  body: '{"customer_id":"cust_987654321"}'
6};
7
8try {
9  const response = await fetch(url, options);
10  const data = await response.json();
11  console.log(data);
12} catch (error) {
13  console.error(error);
14}
1{
2  "object": "onboarding",
3  "id": "onb_123456789abcdef",
4  "display_id": 1024,
5  "customer_id": "cust_987654321",
6  "template_id": "tmpl_abc123xyz",
7  "phase": "before_getting_started",
8  "state": "active",
9  "started_at": "2024-04-01T08:00:00Z",
10  "completed_at": "2024-04-15T17:00:00Z",
11  "target_launch_date": "2024-05-01T09:00:00Z",
12  "csm_id": "user_csm_001",
13  "se_id": "user_se_002",
14  "designer_id": "user_designer_003",
15  "product_ops_id": "user_ops_004",
16  "notes": "Initial onboarding phase started. Awaiting customer feedback on program design.",
17  "waiting_on_customer": true,
18  "waiting_on_customer_since": "2024-04-10T12:00:00Z",
19  "wizard_completed_at": "2024-04-05T15:30:00Z",
20  "reminder_email": true,
21  "reminder_slack": true,
22  "reminder_frequency_days": 1,
23  "created_at": "2024-04-01T07:55:00Z",
24  "updated_at": "2024-04-12T10:20:00Z"
25}

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

Was this page helpful?
Previous

List onboardings

Next

List a customer's onboardings

Built with

Authentication

AuthorizationBearer

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.

Request

This endpoint expects an object.
customer_idstringRequired

Numeric display_id or cuid of the parent customer.

template_idstringOptional
phaseenumOptional
stateenumOptional
Allowed values:
target_launch_datedatetimeOptional
csm_idstring or nullOptional
se_idstring or nullOptional
designer_idstring or nullOptional
product_ops_idstring or nullOptional
notesstringOptional
reminder_emailbooleanOptional
reminder_slackbooleanOptional
reminder_frequency_daysintegerOptional1-30

Response

Created
objectenum
Allowed values:
idstring
display_idinteger
customer_idstring
template_idstring or null
phaseenum
stateenum
Allowed values:
started_atdatetime
completed_atdatetime or null
target_launch_datedatetime or null
csm_idstring or null
se_idstring or null
designer_idstring or null
product_ops_idstring or null
notesstring or null
waiting_on_customerboolean
waiting_on_customer_sincedatetime or null
wizard_completed_atdatetime or null
reminder_emailboolean
reminder_slackboolean
reminder_frequency_daysinteger
created_atdatetime
updated_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error