Add a contact to a customer

const url = 'https://my.pivotal.app/api/v1/customers/42/contacts';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Alice Johnson","email":"alice.johnson@example.com"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "object": "contact",
  "id": "c1234567-89ab-4def-0123-456789abcdef",
  "display_id": 7,
  "customer_id": "42",
  "name": "Alice Johnson",
  "email": "alice.johnson@example.com",
  "title": "Technical Lead",
  "is_primary": false,
  "labels": [
    "engineering",
    "key-contact"
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}

const url = 'https://my.pivotal.app/api/v1/customers/42/contacts';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Alice Johnson","email":"alice.johnson@example.com"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "object": "contact",
  "id": "c1234567-89ab-4def-0123-456789abcdef",
  "display_id": 7,
  "customer_id": "42",
  "name": "Alice Johnson",
  "email": "alice.johnson@example.com",
  "title": "Technical Lead",
  "is_primary": false,
  "labels": [
    "engineering",
    "key-contact"
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}

Email is lowercased on the way in and unique per customer.

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

customerIdstringRequired

Numeric display_id or cuid of the parent customer.

Request

This endpoint expects an object.

namestringRequired1-255 characters

emailstringRequiredformat: "email"<=255 characters

titlestringOptional<=255 characters

is_primarybooleanOptional

labelslist of stringsOptional

Response

Created

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/customers/42/contacts';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{"name":"Alice Johnson","email":"alice.johnson@example.com"}'
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": 7,
5	"customer_id": "42",
6	"name": "Alice Johnson",
7	"email": "alice.johnson@example.com",
8	"title": "Technical Lead",
9	"is_primary": false,
10	"labels": [
11	"engineering",
12	"key-contact"
13	],
14	"created_at": "2024-01-15T09:30:00Z",
15	"updated_at": "2024-01-15T09:30:00Z"
16	}