Update a contact | Pivotal Docs

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 cuid of the contact.

Request

This endpoint expects an object.

namestringOptional1-255 characters

emailstringOptionalformat: "email"<=255 characters

titlestringOptional<=255 characters

is_primarybooleanOptional

labelslist of stringsOptional

Response

objectenum

Allowed values:

idstring

display_idinteger

customer_idstring

namestring

emailstringformat: "email"

titlestring or null

is_primaryboolean

labelslist of strings

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/contacts/12';
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": "contact",
3	"id": "c1234567-89ab-4def-0123-456789abcdef",
4	"display_id": 12,
5	"customer_id": "cust7890",
6	"name": "Jane Doe",
7	"email": "jane.doe@example.com",
8	"title": "Senior Product Manager",
9	"is_primary": false,
10	"labels": [
11	"stakeholder",
12	"marketing"
13	],
14	"created_at": "2024-01-15T09:30:00Z",
15	"updated_at": "2024-04-20T14:45:00Z"
16	}

1	const url = 'https://my.pivotal.app/api/v1/contacts/12';
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": "contact",
3	"id": "c1234567-89ab-4def-0123-456789abcdef",
4	"display_id": 12,
5	"customer_id": "cust7890",
6	"name": "Jane Doe",
7	"email": "jane.doe@example.com",
8	"title": "Senior Product Manager",
9	"is_primary": false,
10	"labels": [
11	"stakeholder",
12	"marketing"
13	],
14	"created_at": "2024-01-15T09:30:00Z",
15	"updated_at": "2024-04-20T14:45:00Z"
16	}