Skip to content

Rule.io SDK


Rule.io SDK / client/src / SubscriberIdentifier

Type Alias: SubscriberIdentifier

SubscriberIdentifier = { email: string; } | { phoneNumber: string; } | { id: number; } | { customIdentifier: string; }

Defined in: client/src/resources/subscribers/subscribers.types.ts:57

Discriminated union for subscriber identification in bulk operations.

Exactly one field must be present — the constraint is enforced at the type level so the API cannot receive zero or two identifiers.

Example

typescript
const identifiers: SubscriberIdentifier[] = [
  { email: 'alice@example.com' },
  { id: 42 },
];