Skip to main content
PATCH
Update profile

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Path Parameters

profileId
string
required
Minimum string length: 1

Body

application/json
language
string

BCP-47 language tag (en, et-EE). Stored normalized: a bare language gets its default region (en becomes en-US).

country
string

ISO 3166-1 alpha-2 country code (EE). Stored upper case.

Response

Default Response

Unified API view of a Profile row, with property data-lineage envelope and segment memberships.

id
string
required
email
string
required

Canonical email identifier from Profile.email (always present).

phone
string | null
required

Optional phone number from Profile.phone. Non-canonical in v1.

language
string | null
required

Canonical customer language preference from Profile.language.

country
string | null
required

ISO 3166-1 alpha-2 customer country from Profile.country.

sources
string[]
required

Distinct segment_membership source tags for this Profile (e.g. 'form_submission', 'csv_import', 'shopify'). Used as a fallback when the Profile has no property assignments tagged with a source.

properties
object
required
segments
object[]
required
deliverySuppression
object
required
createdAt
string
required

ISO timestamp of when this Profile was created

updatedAt
string
required

ISO timestamp of when this Profile was last updated