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
addressobject
The address of the profile
identifiers array
The typed identifiers stitched to this profile
metadata array
The traits/attributes of the profile
segments array
The segments/audiences this profile currently belongs to
is_anonymousboolean
Whether the profile is anonymous (no known identity)
consent array
The consent/privacy preferences of the profile
source_idstring
The cdp_source this profile originated from; points to CdpSource

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for this profile object
created_atstring (date-time)NoThe date that this profile object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this profile object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe full name of the profile
first_namestringNoThe first name of the profile
last_namestringNoThe last name of the profile
emailstringNoThe primary email address of the profile
telephonestringNoThe primary telephone number of the profile
genderenumNoThe gender of the profile Values: MALE, FEMALE, INTERSEX, TRANS, NON_BINARY
birthdatestringNoThe birth date of the profile
titlestringNoThe job title of the profile
companystringNoThe company/organization name of the profile
addressobjectNoThe address of the profile
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.region_codestringNo
address.postal_codestringNo
address.countrystringNo
address.country_codestringNo
identifiersCdpIdentifier[]NoThe typed identifiers stitched to this profile
identifiers[].typeenumNoThe 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[].valuestringYesThe identifier value that resolves to the profile
identifiers[].is_primarybooleanNoWhether this is the primary identifier for the profile
identifiers[].encodingstringNoThe encoding of the identifier value (eg. raw, sha256)
identifiers[].sourcestringNoThe source that provided this identifier
metadataCdpMetadata[]NoThe traits/attributes of the profile
metadata[].idstringNo
metadata[].slugstringNoThe attribute/trait key (eg. lifetime_value)
metadata[].valueobjectNoThe attribute/trait value
metadata[].namespacestringNoThe scope or origin of the attribute (eg. computed, event, visitor)
metadata[].formatenumNoThe data type of the attribute value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT
metadata[].extra_dataobjectNo
segmentsCdpProfileSegment[]NoThe segments/audiences this profile currently belongs to
segments[].segment_idstringNoThe segment/audience this profile belongs to; points to CdpSegment
segments[].namestringNoThe name of the segment/audience
segments[].joined_atstring (date-time)NoWhen the profile joined the segment (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
segments[].expires_atstring (date-time)NoWhen the profile's membership expires (if applicable) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_anonymousbooleanNoWhether the profile is anonymous (no known identity)
consentCdpConsent[]NoThe consent/privacy preferences of the profile
consent[].purposestringNoThe consent purpose or objective (eg. marketing, analytics)
consent[].statusenumNoThe consent status for this purpose Values: GRANTED, DENIED, PENDING
consent[].updated_atstring (date-time)NoWhen the consent status was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
source_idstringNoThe 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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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
Was this page helpful?