Audience Configuration
Relevant source files
The following files were used as context for generating this wiki page:
- src/main/java/com/resend/services/audiences/Audiences.java
- src/main/java/com/resend/services/audiences/model/Audience.java
- src/main/java/com/resend/services/audiences/model/BaseAudience.java
- src/main/java/com/resend/services/audiences/model/CreateAudienceOptions.java
- src/main/java/com/resend/services/audiences/model/CreateAudienceResponseSuccess.java
- src/main/java/com/resend/services/audiences/model/GetAudienceResponseSuccess.java
- src/main/java/com/resend/services/audiences/model/ListAudiencesResponseSuccess.java
Audience Configuration manages the grouping and organization of contacts within the Resend platform. This module allows you to create, retrieve, list, and remove audiences to segment your communication targets. While still functional, the Audiences service is largely deprecated in favor of the newer Segments service.
Sources: src/main/java/com/resend/services/audiences/Audiences.java:13-15, src/main/java/com/resend/services/audiences/Audiences.java:39-44
Service Architecture
The Audiences class provides the primary interface for managing audience data. It extends BaseService and interacts with the Resend API via an HTTP client. Each method in the service maps to a specific RESTful endpoint under the /audiences path.
The diagram shows the inheritance from BaseService and the primary CRUD operations available in the Audiences service.
Sources: src/main/java/com/resend/services/audiences/Audiences.java:13-20, src/main/java/com/resend/services/audiences/Audiences.java:44-88
Data Models
The Audience system uses a structured hierarchy of models to represent audience data and API responses. The BaseAudience class contains common fields like id and name, which are shared across specialized response types.
Audience Object Structure
| Field | Type | Description |
|---|---|---|
id | String | Unique identifier for the audience. |
name | String | User-defined name for the audience. |
created_at | String | Timestamp indicating when the audience was created. |
object | String | Type of object (typically "audience"). |
Sources: src/main/java/com/resend/services/audiences/model/BaseAudience.java:1-25, src/main/java/com/resend/services/audiences/model/Audience.java:8-35, src/main/java/com/resend/services/audiences/model/GetAudienceResponseSuccess.java:8-33
Creation Configuration
To create an audience, you use the CreateAudienceOptions builder. This object requires a name to identify the new group.
CreateAudienceOptions options = CreateAudienceOptions.builder()
.name("Marketing Leads")
.build();
Sources: src/main/java/com/resend/services/audiences/model/CreateAudienceOptions.java:10-45
Operations and Data Flow
The Audiences service executes requests by serializing option objects into JSON and performing HTTP operations.
This diagram illustrates the flow of data during the creation of a new audience.
Sources: src/main/java/com/resend/services/audiences/Audiences.java:44-48, src/test/java/com/resend/services/audiences/AudiencesTest.java:48-60
Pagination and Listing
The list operation supports pagination through ListParams. The response includes a hasMore indicator to notify the caller if additional pages of data exist.
| Method | Endpoint | Return Type |
|---|---|---|
list() | GET /audiences | ListAudiencesResponseSuccess |
list(ListParams) | GET /audiences?limit=... | ListAudiencesResponseSuccess |
Sources: src/main/java/com/resend/services/audiences/Audiences.java:58-75, src/main/java/com/resend/services/audiences/model/ListAudiencesResponseSuccess.java:11-40
Deprecation Notice
Most methods in the Audiences service are marked as @Deprecated. You should migrate to the Segments service for equivalent functionality.
| Deprecated Method | Recommended Alternative |
|---|---|
create(CreateAudienceOptions) | Segments.create(CreateSegmentOptions) |
list() | Segments.list() |
get(String) | Segments.get(String) |
remove(String) | Segments.remove(String) |
Sources: src/main/java/com/resend/services/audiences/Audiences.java:43, src/main/java/com/resend/services/audiences/Audiences.java:57, src/main/java/com/resend/services/audiences/Audiences.java:83, src/main/java/com/resend/services/audiences/Audiences.java:95
Summary
The Audience Configuration module provides essential tools for managing contact groups via the Audiences class and its associated models. It supports standard CRUD operations and paginated listing. Developers should plan a migration to the Segments service, as current Audience methods are deprecated and point to the Segments API for future use.