Skip to main content

Contact

Stored in the contacts collection. createdAt and updatedAt are maintained automatically.

Returned by DELETE /contact, POST /contact, PUT /contact/:id, POST /enrich/contact, GET /lead-gen-ai/:configId.

FieldTypeNotes
companyObjectId -> Company
fieldsobject[]default []
fields._idObjectId -> CustomFieldrequired
fields.valueany
customFieldsMapmapdefault {}
tagsObjectId[] -> Tagdefault []
tagsSnapshotobject[]default []
tagsSnapshot.tagObjectId
tagsSnapshot.namestring
tagsSnapshot.colorstring
contactcategoriesObjectId -> ContactCategory
contactCategorySnapshotobject
contactCategorySnapshot.contactCategoryObjectId
contactCategorySnapshot.namestring
namestring
emailstring
instagramUserIdstring
servicesobject[]default []
services.serviceTypestring
services.descriptionstring
services.linkstring
services._idObjectIddefault "6a95712f932657988a91c07a"
contactNumber.countryCodestring
contactNumber.numberstring
work_phone_number.countryCodestring
work_phone_number.numberstring
whatsapp_contact_number.countryCodestring
whatsapp_contact_number.numberstring
jobTitlestring
companyData.namestring
companyData.websitestring
companyData.industrystringone of Information Technology (IT), Healthcare, Financial Services, E-commerce, Manufacturing, Education, Real Estate, Logistics and 7 more
companyData.otherIndustrystring
companyData.sizestringone of Self-employed, 0-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000 and 1 more
companyData.locationstring
addressstring
countrystring
statestring
citystring
postalCodestring
descriptionstring
social.facebookstring
social.twitterstring
social.linkedinstring
social.instagramstring
social.youtubestring
social.tiktokstring
social.personalWebsitestring
enrichMetaDataobjectdefault {}
enrichMetaData.contactUpdatedByEnrichmentbooleandefault false
enrichMetaData.nothingFoundToEnrichbooleandefault false
enrichMetaData.foundToEnrichButContactAlreadyHasFieldsbooleandefault false
enrichMetaData.foundFieldsToEnrichbooleandefault false
enrichMetaData.lastEnrichedAtdatedefault null
enrichMetaData.lastEnrichmentUrlstringdefault ""
enrichMetaData.lastEnrichmentScheduleObjectId -> EnrichmentScheduledefault null
enrichMetaData.changedFieldsstring[]default []
enrichmentStatusstringone of queued, processing, completed, failed
enrichmentRequestedAtdate
enrichmentDoneAtdate
enrichmentLeadIdObjectId -> Leaddefault null
enrichmentCountnumberdefault 0
enrichmentHistoryobject[]default []
enrichmentHistory.statusstringdefault queued · one of queued, processing, completed, failed
enrichmentHistory.requestedAtdatedefault now
enrichmentHistory.startedAtdatedefault null
enrichmentHistory.doneAtdatedefault null
enrichmentHistory.leadObjectId -> Leaddefault null
enrichmentHistory.sourcestringdefault manual
enrichmentHistory.genieSchedulerObjectId -> GenieSchedulerdefault null
enrichmentHistory.callbackUrlstringdefault ""
enrichmentHistory.fieldThresholdnumberdefault 4
enrichmentHistory.changedFieldsstring[]default []
enrichmentHistory.errorstringdefault ""
enrichmentHistory._idObjectIddefault "6a95712f932657988a91c07b"
enrichmentHistory.createdAtdateset once
enrichmentHistory.updatedAtdate
sourcestringone of Bulk Import, Offline, Facebook, Website, AI Generated, Instagram, Whatsapp, SMS and 5 more
sourceIdObjectId
importIdObjectId[] -> Importdefault []
importSnapshotobject[]default []
importSnapshot.importObjectId
importSnapshot.fileNamestring
fullContactNumberstring
searchTextstring
assignedMembersObjectId[] -> Memberdefault []
leadsCreatedByMembersObjectId[] -> Memberdefault []
createdByObjectId -> Member
createdBySnapshotobject
createdBySnapshot.memberObjectId
createdBySnapshot.namestring
createdBySnapshot.emailstring
updatedByObjectId -> Member
updatedBySnapshotobject
updatedBySnapshot.memberObjectId
updatedBySnapshot.namestring
updatedBySnapshot.emailstring
isDeletedbooleandefault false
isRestoredbooleandefault false
restoredAtdate
aiGeneratedbooleandefault false
leadGeneratorConfigIdObjectId -> LeadGeneratorConfig
genieSchedulerIdObjectId -> GenieScheduler
_idObjectIddefault "6a95712f932657988a91c07c"
createdAtdateset once
updatedAtdate