Skip to content

SDK method

tools.addContacts

Bulk-add contacts. Convenience alias for add_contacts, forwarding to tinbox.api.contacts.batchUpsert.mutate.

Signature

ts
addContacts(input: Parameters<TinboxTools["addContacts"]>[0]): ReturnType<TinboxTools["addContacts"]>

Parameters

NameTypeRequiredDescription
contactsobject[]yesThe contacts to add.
defaultLabelsstring[]noLabels applied to EVERY contact in the batch.
queryunknownnoThe prompt/criteria that produced this batch (e.g. 'YC fintech companies').

Returns

ReturnType<TinboxTools["addContacts"]>

Example

ts
await tinbox.tools.addContacts({
  "contacts": [
    {
      "email": "ada@example.com"
    }
  ]
});