Skip to main content

RecipientDto

Who the notification is for, and how each channel can reach them.

Only subscriberId is required. The contact fields you supply determine which channels are eligible: omit email and no email will be attempted.

deviceTokensstring[]nullable

FCM or APNs device tokens for the push channel.

emailstring | nullnullable

Email address for the email channel.

Example: ada@example.com
phonestring | nullnullable

E.164 phone number for the sms, whatsapp and voice channels.

Example: +2348012345678
subscriberIdstringrequired

Your stable identifier for the end user. Also the rate-limit bucket and the last segment of the NATS subject the event is published to.

Example: user_8f21c
RecipientDto
{
  "deviceTokens": "Unknown Type: array,null",
  "email": "ada@example.com",
  "phone": "+2348012345678",
  "subscriberId": "user_8f21c"
}