Update a customer | Pivotal Docs

const url = 'https://my.pivotal.app/api/v1/customers/42';
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": "customer",
  "id": "clxabc123",
  "display_id": 42,
  "name": "Acme Co.",
  "slug": "acme-co",
  "domain": "acme.com",
  "status": "active",
  "plan": "enterprise",
  "mrr": 150000,
  "monthly_orders": 120,
  "hubspot_company_id": "HS123456",
  "hubspot_deal_id": "HD654321",
  "stripe_customer_id": "cus_J5K8d9f7gH2L",
  "intercom_company_id": "intco_78910",
  "slack_channel_id": "C1234567890",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}

Partial update. Send only the fields you want to change.

const url = 'https://my.pivotal.app/api/v1/customers/42';
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": "customer",
  "id": "clxabc123",
  "display_id": 42,
  "name": "Acme Co.",
  "slug": "acme-co",
  "domain": "acme.com",
  "status": "active",
  "plan": "enterprise",
  "mrr": 150000,
  "monthly_orders": 120,
  "hubspot_company_id": "HS123456",
  "hubspot_deal_id": "HD654321",
  "stripe_customer_id": "cus_J5K8d9f7gH2L",
  "intercom_company_id": "intco_78910",
  "slack_channel_id": "C1234567890",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}

Partial update. Send only the fields you want to change.

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 canonical cuid id.

Request

This endpoint expects an object.

namestringOptional1-255 characters

slugstringOptional1-120 characters

domainstringOptional<=255 characters

statusenumOptional

Allowed values:

planstringOptional<=120 characters

mrrintegerOptional>=0

monthly_ordersintegerOptional>=0

hubspot_company_idstringOptional

hubspot_deal_idstringOptional

stripe_customer_idstringOptional

intercom_company_idstringOptional

slack_channel_idstringOptional

Response

objectenum

Allowed values:

idstring

display_idinteger

namestring

slugstring or null

domainstring or null

statusstring

planstring or null

mrrinteger or null

Monthly recurring revenue in cents.

monthly_ordersinteger or null

hubspot_company_idstring or null

hubspot_deal_idstring or null

stripe_customer_idstring or null

intercom_company_idstring or null

slack_channel_idstring or null

created_atdatetime

updated_atdatetime

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

1	const url = 'https://my.pivotal.app/api/v1/customers/42';
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": "customer",
3	"id": "clxabc123",
4	"display_id": 42,
5	"name": "Acme Co.",
6	"slug": "acme-co",
7	"domain": "acme.com",
8	"status": "active",
9	"plan": "enterprise",
10	"mrr": 150000,
11	"monthly_orders": 120,
12	"hubspot_company_id": "HS123456",
13	"hubspot_deal_id": "HD654321",
14	"stripe_customer_id": "cus_J5K8d9f7gH2L",
15	"intercom_company_id": "intco_78910",
16	"slack_channel_id": "C1234567890",
17	"created_at": "2024-01-15T09:30:00Z",
18	"updated_at": "2024-01-15T09:30:00Z"
19	}