Update an onboarding | Pivotal Docs

const url = 'https://my.pivotal.app/api/v1/onboardings/17';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "object": "onboarding",
  "id": "onb_9f8e7d6c5b4a3e2f1d0c",
  "display_id": 17,
  "customer_id": "cust_1234567890abcdef",
  "template_id": "tmpl_abcdef1234567890",
  "phase": "program_design",
  "state": "active",
  "started_at": "2024-01-10T08:00:00Z",
  "completed_at": "2024-02-20T17:00:00Z",
  "target_launch_date": "2024-03-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 completed, awaiting client feedback.",
  "waiting_on_customer": true,
  "waiting_on_customer_since": "2024-02-15T12:00:00Z",
  "wizard_completed_at": "2024-01-15T10:30:00Z",
  "reminder_email": true,
  "reminder_slack": false,
  "reminder_frequency_days": 7,
  "created_at": "2024-01-10T07:45:00Z",
  "updated_at": "2024-02-20T17:05:00Z"
}

Partial update. Setting state=waiting flips waiting_on_customer=true; setting any other state clears it.

const url = 'https://my.pivotal.app/api/v1/onboardings/17';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "object": "onboarding",
  "id": "onb_9f8e7d6c5b4a3e2f1d0c",
  "display_id": 17,
  "customer_id": "cust_1234567890abcdef",
  "template_id": "tmpl_abcdef1234567890",
  "phase": "program_design",
  "state": "active",
  "started_at": "2024-01-10T08:00:00Z",
  "completed_at": "2024-02-20T17:00:00Z",
  "target_launch_date": "2024-03-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 completed, awaiting client feedback.",
  "waiting_on_customer": true,
  "waiting_on_customer_since": "2024-02-15T12:00:00Z",
  "wizard_completed_at": "2024-01-15T10:30:00Z",
  "reminder_email": true,
  "reminder_slack": false,
  "reminder_frequency_days": 7,
  "created_at": "2024-01-10T07:45:00Z",
  "updated_at": "2024-02-20T17:05:00Z"
}

Partial update. Setting state=waiting flips waiting_on_customer=true; setting any other state clears it.

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.

Path parameters

idstringRequired

Numeric display_id or cuid of the onboarding.

Request

This endpoint expects an object.

template_idstring or nullOptional

phaseenumOptional

stateenumOptional

Allowed values:

target_launch_datedatetime or nullOptional

completed_atdatetime or nullOptional

csm_idstring or nullOptional

se_idstring or nullOptional

designer_idstring or nullOptional

product_ops_idstring or nullOptional

notesstring or nullOptional

waiting_on_customerbooleanOptional

reminder_emailbooleanOptional

reminder_slackbooleanOptional

reminder_frequency_daysintegerOptional1-30

Response

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

1	const url = 'https://my.pivotal.app/api/v1/onboardings/17';
2	const options = {
3	method: 'PATCH',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
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_9f8e7d6c5b4a3e2f1d0c",
4	"display_id": 17,
5	"customer_id": "cust_1234567890abcdef",
6	"template_id": "tmpl_abcdef1234567890",
7	"phase": "program_design",
8	"state": "active",
9	"started_at": "2024-01-10T08:00:00Z",
10	"completed_at": "2024-02-20T17:00:00Z",
11	"target_launch_date": "2024-03-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 completed, awaiting client feedback.",
17	"waiting_on_customer": true,
18	"waiting_on_customer_since": "2024-02-15T12:00:00Z",
19	"wizard_completed_at": "2024-01-15T10:30:00Z",
20	"reminder_email": true,
21	"reminder_slack": false,
22	"reminder_frequency_days": 7,
23	"created_at": "2024-01-10T07:45:00Z",
24	"updated_at": "2024-02-20T17:05:00Z"
25	}