Create a profile
POST/cdp/{connection_id}/profile
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
Payload
idstring
Unique identifier for this profile object
created_atdate-time
The date that this profile object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
The last date that this profile object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The full name of the profile
first_namestring
The first name of the profile
last_namestring
The last name of the profile
emailstring
The primary email address of the profile
telephonestring
The primary telephone number of the profile
gender enum
Valid values:
"MALE"
"FEMALE"
"INTERSEX"
"TRANS"
"NON_BINARY"
The gender of the profile
birthdatestring
The birth date of the profile
titlestring
The job title of the profile
companystring
The company/organization name of the profile
is_anonymousboolean
Whether the profile is anonymous (no known identity)
source_idstring
The cdp_source this profile originated from; points to CdpSource
Returns
| Response 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 |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'POST',
url: 'https://api.unified.to/cdp/5de520f96e439b002043d8dc/profile',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know