Delete an onboarding | Pivotal Docs

Soft delete — preserved for audit, hidden from reads.

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.

Response

objectenum

Allowed values:

idstring

display_idinteger

deletedboolean

Errors

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://my.pivotal.app/api/v1/onboardings/17';
2	const options = {
3	method: 'DELETE',
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": "deleted",
3	"id": "onb_9f8e7d6c5b4a3",
4	"display_id": 17,
5	"deleted": true
6	}

1	const url = 'https://my.pivotal.app/api/v1/onboardings/17';
2	const options = {
3	method: 'DELETE',
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": "deleted",
3	"id": "onb_9f8e7d6c5b4a3",
4	"display_id": 17,
5	"deleted": true
6	}