Skip to content

SDK method

tools.importContacts

Import contacts. Convenience alias for import_contacts, forwarding to tinbox.api.members.importCsv.mutate.

Signature

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

Parameters

NameTypeRequiredDescription
audienceIdstringyesThe destination audience (mailing list) id.
csvstringyesCSV text: a header row with an `email` column (optional `name` + merge-field columns), then one row per contact.
status"pending" | "subscribed" | "unsubscribed" | "cleaned" | "transactional"noInitial membership status for NEWLY created members (existing keep theirs).

Returns

ReturnType<TinboxTools["importContacts"]>

Example

ts
await tinbox.tools.importContacts({
  "audienceId": "aud_…",
  "csv": "<csv>"
});