Add records to lists

addRecordsToList adds contacts or accounts to named Apollo lists, creating missing lists when Apollo permits.

automations/add-apollo-list-members.automation.ts

import { addRecordsToList } from "automate.ax/apollo"
import { automation, onHttpRequest } from "automate.ax"

export default automation("Add contacts to Apollo lists", () => {
  onHttpRequest({ scope: "automation" })
  addRecordsToList({
    recordType: "contacts",
    records: ["ada@example.com", "grace@example.com"],
    listNames: ["Event Leads"],
  })
})

recordType is "contacts" | "accounts"; records and listNames are non-empty arrays. Set async: true for background processing of a large change. Optional account selects the Apollo binding. Returns { lists, job?, message? }. Synchronous changes return affected lists; asynchronous changes return a job with jobId, entity IDs, progress, type, and optional batch/user metadata.

⌘I

Get started

Concepts

Reference