SendEmailBase

Properties

NameType
distinctIdstring

The recipient's distinct ID in your product. The email's events go to this person. Without it, they go to a person whose distinct ID is the email address.

idempotencyKeystring

1 to 255 visible ASCII characters. A send with a key that PostHog has already accepted queues nothing and returns the first send's result. The same key with other options sends nothing and returns an error with code idempotency_key_reused. Without it, the client makes a UUID that covers its own retries. Pass a key derived from what the email is for, such as welcome:user_123, to cover retries outside this call too.

maxRetriesnumber

Overrides the client's emailRequestMaxRetries for this send. 0 turns retries off.

tostring

One recipient email address.