Profile data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this profile object |
created_at | string (date-time) | No | The date that this profile object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this profile object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The full name of the profile |
first_name | string | No | The first name of the profile |
last_name | string | No | The last name of the profile |
email | string | No | The primary email address of the profile |
telephone | string | No | The primary telephone number of the profile |
gender | enum | No | The gender of the profile Values: MALE, FEMALE, INTERSEX, TRANS, NON_BINARY |
birthdate | string | No | The birth date of the profile |
title | string | No | The job title of the profile |
company | string | No | The company/organization name of the profile |
address | object | No | The address of the profile |
address.address1 | string | No | |
address.address2 | string | No | |
address.city | string | No | |
address.region | string | No | |
address.region_code | string | No | |
address.postal_code | string | No | |
address.country | string | No | |
address.country_code | string | No | |
identifiers | CdpIdentifier[] | No | The typed identifiers stitched to this profile |
identifiers[].type | enum | No | The type of the identifier (eg. EMAIL, USER_ID, ANONYMOUS_ID) Values: EMAIL, USER_ID, ANONYMOUS_ID, DEVICE_ID, PHONE, CRM_ID, LOYALTY_ID, OTHER |
identifiers[].value | string | Yes | The identifier value that resolves to the profile |
identifiers[].is_primary | boolean | No | Whether this is the primary identifier for the profile |
identifiers[].encoding | string | No | The encoding of the identifier value (eg. raw, sha256) |
identifiers[].source | string | No | The source that provided this identifier |
metadata | CdpMetadata[] | No | The traits/attributes of the profile |
metadata[].id | string | No | |
metadata[].slug | string | No | The attribute/trait key (eg. lifetime_value) |
metadata[].value | object | No | The attribute/trait value |
metadata[].namespace | string | No | The scope or origin of the attribute (eg. computed, event, visitor) |
metadata[].format | enum | No | The data type of the attribute value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | |
segments | CdpProfileSegment[] | No | The segments/audiences this profile currently belongs to |
segments[].segment_id | string | No | The segment/audience this profile belongs to; points to CdpSegment |
segments[].name | string | No | The name of the segment/audience |
segments[].joined_at | string (date-time) | No | When the profile joined the segment (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
segments[].expires_at | string (date-time) | No | When the profile's membership expires (if applicable) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
is_anonymous | boolean | No | Whether the profile is anonymous (no known identity) |
consent | CdpConsent[] | No | The consent/privacy preferences of the profile |
consent[].purpose | string | No | The consent purpose or objective (eg. marketing, analytics) |
consent[].status | enum | No | The consent status for this purpose Values: GRANTED, DENIED, PENDING |
consent[].updated_at | string (date-time) | No | When the consent status was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
source_id | string | No | The cdp_source this profile originated from; points to CdpSource |
Are we missing anything? Let us know