Creates a new contact.

The createContact() function returns a Promise that resolves to the new contact when it is created.

The info parameter object must include a name, phone number, or email address. If all 3 of these parameters are missing, the contact won't be created.

By default, if the call contains an email already in use by another contact, the new contact won't be created. To override this behavior, set allowDuplicates in the options object to true.

function createContact(info: ContactInfo, options: CreateContactOptions): Promise<CreateContactResponse>

Deletes a contact who is not a site member or contributor.

The deleteContact() function returns a Promise that resolves when the specified contact is deleted.

Deleting a contact permanently removes them from your Contact List.

If the contact is also a site member, the member must be deleted first, and then the contact can be deleted.

function deleteContact(contactId: string): Promise<void>

Retrieves a contact.

The getContact() function returns a Promise that resolves when the contact is found.

Getting Merged Contacts

When a source contact is merged into a target contact, the source contact is deleted. When calling getContact() for a merged contact, you can use the source or target contact ID. In both cases, the target contact is returned.

This is supported only when calling getContact()on merged contacts. Previously deleted source contact IDs can't be passed to any other function.

function getContact(_id: string, options: GetContactOptions): Promise<Contact>

Adds labels to a contact.

The labelContact() function returns a Promise that resolves when the specified labels are added to the contact.

• To create new labels: Use findOrCreateLabel().
• To find labels: Use findOrCreateLabel(), getLabel(), or queryLabels().

function labelContact(contactId: string, labelKeys: Array<string>): Promise<LabelContactResponse>

Merges source contacts into a target contact.

Merging contacts has these effects on the target contact:

• No target contact data is overwritten or deleted.
• Arrays (emails, phones, addresses, and labels) are merged from the source contacts into the target contact.
• If merging more than one source contact, the 1st source is given precedence, then the 2nd, and so on.

Source contacts are deleted when merging. However, if a source contact is a site member or collaborator, the mergeContacts() function fails because site collaborators and members can't be deleted. Site members and collaborators can only be target contacts.

After merging, if you call the getContact() function with a deleted source contact ID, the target contact ID is returned. This is only supported when calling getContact(). Previously deleted source contact IDs can't be passed in any other function.

function mergeContacts(targetContactId: string, targetContactRevision: number, options: MergeContactsOptions): Promise<MergeContactsResponse>

Creates a query to retrieve a list of contacts.

The queryContacts() function builds a query to retrieve a list of contacts and returns a ContactsQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() function.

You can refine the query by chaining ContactsQueryBuilder functions onto the query. ContactsQueryBuilder functions enable you to sort, filter, and control the results queryContacts() returns.

queryContacts() runs with these ContactsQueryBuilder defaults, which you can override:

• skip(0)
• limit(50)
• descending("_createdDate")

The functions that are chained to queryContacts() are applied in the order they are called. For example, if you apply ascending('info.company') and then descending('info.name.last'), the results are sorted first by the company name, and then, if there are multiple results with the same company, the items are sorted by last name.

PROPERTY	SUPPORTED FILTERS & SORTING
_id	eq(),ne(),in(),exists()
_createdDate	eq(),ne(),gt(),lt(),ge(),le(),ascending(),descending()
_updatedDate	eq(),ne(),gt(),lt(),ge(),le()
lastActivity.activityDate	eq(),ne(),gt(),lt(),ge(),le(),ascending(),descending()
primaryInfo.email	eq(),ne(),in(),exists(),startsWith(),ascending(),descending()
primaryInfo.phone	eq(),ne(),in(),exists(),startsWith()
info.name.first	eq(),ne(),in(),exists(),startsWith(),ascending(),descending()
info.name.last	eq(),ne(),in(),exists(),startsWith(),ascending(),descending()
info.company	eq(),ne(),in(),exists(),startsWith(),ascending(),descending()
info.jobTitle	eq(),ne(),in(),exists(),startsWith(),ascending(),descending()
info.birthdate	eq(),ne(),ascending(),descending()
info.locale	eq(),ne(),in(),exists()
primaryEmail.email	eq(),ne(),in(),exists(),startsWith(),ascending(),descending()
primaryEmail.subscriptionStatus	eq(),ne(),in()
primaryEmail.deliverabilityStatus	eq(),ne(),in()
primaryPhone.countryCode	eq(),ne(),in(),exists(),startsWith(),ascending(),descending()
primaryPhone.e164Phone	eq(),ne(),in(),exists(),startsWith()
primaryPhone.formattedPhone	eq(),ne(),in(),exists(),startsWith(),ascending(),descending()
primaryPhone.subscriptionStatus	eq(),ne(),in()
primaryPhone.phone	eq(),ne(),in(),exists(),startsWith()

function queryContacts(options: QueryContactsOptions): ContactsQueryBuilder

Removes labels from a contact.

The unlabelContact() function returns a Promise that resolves when the specified labels are removed from the contact.

If a label is no longer needed and you want to remove it from all contacts, you can remove it with the Labels deleteLabel() function.

function unlabelContact(contactId: string, labelKeys: Array<string>): Promise<UnlabelContactResponse>

Updates a contact's properties.

The updateContact() function returns a Promise that resolves when the specified contact's information is updated.

Each time the contact is updated, revision increments by 1. The existing revision must be included when updating the contact. This ensures you're working with the latest contact information, and prevents unintended overwrites.

function updateContact(contactId: string, info: ContactInfo, revision: number, options: UpdateContactOptions): Promise<UpdateContactResponse>