Update a contact

curl --request PATCH 'https://api.brightalk.ai/contacts/con_demo_001' \ --header "Authorization: Bearer $BRIGHTALK_API_KEY" \ --header "Brightalk-Version: 2026-07-16" \ --header "Content-Type: application/json" \ --data '{"company":"Example Co."}'

const response = await fetch("https://api.brightalk.ai/contacts/con_demo_001", { method: "PATCH", headers: { Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`, "Brightalk-Version": "2026-07-16", "Content-Type": "application/json", }, body: JSON.stringify({"company":"Example Co."}), }); console.log(response.status, await response.json());

import os import requests response = requests.request( "PATCH", "https://api.brightalk.ai/contacts/con_demo_001", headers={ "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}", "Brightalk-Version": "2026-07-16", "Content-Type": "application/json", }, json={"company":"Example Co."}, ) print(response.status_code, response.json())

{ "id": "con_demo_001", "external_id": "customer-8421", "source": "public_api", "name": "Example Customer", "phone_number": "+12025550123", "email": "customer@example.com", "company": "Example Co.", "role": "Operations Manager", "city": "Taipei", "country": "TW", "created_at": "2026-07-20T01:00:00Z", "updated_at": "2026-07-20T01:00:00Z" }

Authorizations

Authorization

string

header

required

Use a private-beta server credential in the Authorization header.

Headers

Brightalk-Version

string

default:2026-07-16

Selects the date-based API version. Omission uses the organization’s pinned private-beta default.

Allowed value: "2026-07-16"

X-Request-Id

string

A caller-generated correlation value matching [A-Za-z0-9._:-]{1,64}. Invalid values are replaced.

Maximum string length: 64

Pattern: ^[A-Za-z0-9._:-]{1,64}$

Path Parameters

contact_id

string

required

The opaque Contact identifier. An opaque resource identifier.

Required string length: 1 - 255

Example:

"con_demo_001"

Body

application/json

JSON request body. The raw encoded body is limited to 1 MiB and unknown fields are rejected.

name

string

Leading and trailing whitespace is trimmed; the remaining value must contain 1–255 characters.

Pattern: ^\s*\S(?:[\s\S]{0,253}\S)?\s*$

Example:

"Example Customer"

phone_number

string

A strict E.164 phone number.

Pattern: ^\+[1-9]\d{7,14}$

Example:

"+12025550123"

string<email> | null

Maximum string length: 320

Example:

"customer@example.com"

company

string | null

Leading and trailing whitespace is trimmed; the remaining value may contain at most 255 characters.

Pattern: ^\s*(?:\S(?:[\s\S]{0,253}\S)?)?\s*$

Example:

"Example Co."

role

string | null

Leading and trailing whitespace is trimmed; the remaining value may contain at most 255 characters.

Pattern: ^\s*(?:\S(?:[\s\S]{0,253}\S)?)?\s*$

Example:

"Operations Manager"

city

string | null

Leading and trailing whitespace is trimmed; the remaining value may contain at most 255 characters.

Pattern: ^\s*(?:\S(?:[\s\S]{0,253}\S)?)?\s*$

Example:

"Taipei"

country

string | null

Leading and trailing whitespace is trimmed; the remaining value may contain at most 255 characters.

Pattern: ^\s*(?:\S(?:[\s\S]{0,253}\S)?)?\s*$

Example:

"TW"

Response

Contact updated.

string

required

An opaque resource identifier.

Required string length: 1 - 255

Example:

"con_demo_001"

external_id

string | null

required

The caller-managed external identity.

Example:

"customer-8421"

source

string | null

required

The external identity namespace.

Example:

"public_api"

name

string

required

Example:

"Example Customer"

phone_number

string

required

Pattern: ^\+[1-9]\d{7,14}$

Example:

"+12025550123"

string | null

required

The contact email address.

Example:

"customer@example.com"

company

string | null

required

The contact company.

Example:

"Example Co."

role

string | null

required

The contact role.

Example:

"Operations Manager"

city

string | null

required

The contact city.

Example:

"Taipei"

country

string | null

required

The contact country.

Example:

"TW"

created_at

string<date-time>

required

When the contact was created.

Example:

"2026-07-20T01:00:00Z"

updated_at

string<date-time>

required

When the contact was last updated.

Example:

"2026-07-20T01:00:00Z"

Get started

API fundamentals

Core concepts

Guides

Release information

API Reference

Authorizations

Headers

Path Parameters

Body

Response