Skip to main content
The $lettr->audience() service manages everything campaigns send to: contact lists, the contacts themselves, subscription topics, custom properties, and dynamic segments. Each is a sub-service:
All five expose the same CRUD shape — list(), get(), create(), update(), delete() — with a few bulk and relationship helpers on contacts and lists.

Lists

A list is a static collection of contacts.

API Reference

GET /audience/lists

Contacts

A contact is an email address with optional custom properties, optionally attached to a list on creation.
Contact status is one of Subscribed, Unsubscribed, Bounced, Complained, or Unverified.

API Reference

GET /audience/contacts

Double opt-in

Pass a DoubleOptInConfig to send a confirmation email before the contact becomes subscribed:

Bulk operations

Single relationships

API Reference

POST /audience/contacts//lists/

Topics

Topics are subscription categories contacts can opt in or out of (e.g. “Product updates”, “Promotions”).

API Reference

GET /audience/topics

Properties

Properties are typed custom fields stored on each contact.

API Reference

GET /audience/properties

Segments

A segment is a dynamic group defined by conditions over contact fields and properties. Conditions are grouped — conditions within a group are AND-ed, and groups are OR-ed together.
Operators include Equals, NotEquals, Contains, StartsWith, EndsWith, GreaterThan, LessThan, Before, After, IsTrue, IsFalse, and their negations.

API Reference

GET /audience/segments

What’s Next

Campaigns

Send to your audience

API Reference

Full audience API reference