Skip to main content

CRM

Contact

FieldTypeDescription
idID!The ID of the contact.
emailString!The email address of the contact.
phoneStringThe phone number of the contact.
firstNameStringThe first name of the contact.
lastNameStringThe last name of the contact.
addressContactAddressAn address object for the contact.
metadataContactMetadataA key-value pair of metadata for the contact.
createdAtDateThe date on which the contact was created.
updatedAtDateThe last date on which the contact was updated.
lastSeenAtDateThe time when the contact was last seen.
userIdID (READONLY)ID of the eventOne user associated with this contact.

ContactMetadata

FieldTypeDescription
keyStringThe key of the property.
valueStringThe value of the property.
typeMetadataDataType (READONLY)The data type of the property.

ContactAddress

FieldTypeDescription
cityStringCity, district, suburb, town, or village.
countryStringTwo-letter country code (ISO 3166-1 alpha-2).
line1StringAddress line 1 (e.g., street, PO Box, or company name).
line2StringAddress line 2 (e.g., apartment, suite, unit, or building).
postalCodeStringZIP or postal code.
stateStringState, county, province, or region.

MetadataDataType

NameDescription
number
date
boolean
null
array
string

Example

{
"id": "5ee147ddc0864c0ef9eacf8d",
"email": "[email protected]",
"phone": "+1123456789",
"firstName": "Noah",
"lastName": "Prail",
"address": {
"city": "Example",
"country": "US",
"line1": "1234 Example St.",
"line2": null,
"postalCode": "12345",
"state": "IN"
},
"metadata": [
{
"key": "My Custom Field",
"value": "Any value!",
"type": "string"
},
{
"key": "is_member",
"value": "true",
"type": "boolean"
}
],
"createdAt": "2020-06-10T20:53:36.148Z",
"updatedAt": "2020-06-10T20:53:43.505Z",
"lastSeenAt": "2020-06-10T20:53:59.201Z",
"id": "5f11ce55bc25550548e44863"
}