Audience

Contacts

The people you email — created, updated, and looked up by address.

Contacts are the individuals in your audience. Create them directly, import in bulk, or let them arrive through sign-up flows.

POST/v1/contactsCreate or upsert a contact.

GET/v1/contactsBrowse contacts — paged, with q (email/name search), tag, status, and stage filters; returns total.

GET/v1/contacts/tagsDistinct tags across your contacts, with how many carry each.

GET/v1/contacts/:emailLook a contact up by email address.

POST/v1/contacts/unsubscribeUnsubscribe a contact from marketing mail.

The full relationship (CRM)

Each contact is a full profile: audiences, notes, lifecycle events (subscribed, unsubscribed, waitlisted, admitted) and recent sends with open/click times. Custom metadata fields personalize templates automatically, and status changes carry their real side effects — unsubscribing suppresses, resubscribing clears the suppression, and new tags can enroll into tag-triggered sequences.

GET/v1/contacts/id/:idThe full CRM view — profile, stage, audiences, notes, lifecycle events, recent sends.

GET/v1/contacts/stagesHow many contacts sit at each lifecycle stage — the pipeline at a glance.

DELETE/v1/contacts/id/:idDelete a contact (memberships and notes go too; send history stays).

POST/v1/contacts/id/:id/notesAdd a note to a contact.

DELETE/v1/contacts/id/:id/notes/:noteIdRemove a note.

contact.ts

await mail.contacts.create({
  email: "ada@example.com",
  name: "Ada Lovelace",
  attributes: { plan: "pro", signup_source: "docs" },
});

noteYour marketing plan is priced by contact size — see Pricing.

PreviousSuppressions Next Audiences (lists)