Create an onboarding | Pivotal Docs

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);
}

{
  "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"
}

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

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

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

idstring

display_idinteger

customer_idstring

template_idstring or null

phaseenum

stateenum

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