Interface AudienceProvider

The swappable audience binding — mirror contacts to an email-provider audience/list.

interface AudienceProvider {
    id: string;
    upsert(
        audienceId: string,
        contact: AudienceContact,
    ): Promise<AudienceResult>;
    remove(audienceId: string, email: string): Promise<AudienceResult>;
}

Index

Properties

Methods

Properties

`Readonly`id

id: string

a stable id (e.g. "resend", "console").

Methods

upsert

upsert(audienceId: string, contact: AudienceContact): Promise<AudienceResult>
add or update a contact in the audience (idempotent upsert).
Parameters
- audienceId: string
- contact: AudienceContact
Returns Promise<AudienceResult>
- Defined in audience.ts:29

remove

remove(audienceId: string, email: string): Promise<AudienceResult>
remove (or unsubscribe) a contact from the audience.
Parameters
- audienceId: string
- email: string
Returns Promise<AudienceResult>
- Defined in audience.ts:31