Email API
Send emails to your members from your own system with the Subrite email API. Set up an M2M token, look up senders, lists and templates, then send, schedule, test or edit emails.
OverviewView as Markdown
Send Email is a powerful feature that lets you reach all your members directly. Combined with the list functionality, you can target any segment of your user base and tailor your message to them. You can easily add images, links, and call-to-action buttons to make your emails more engaging and drive action. Choose to send your emails directly from Subrite or through our API, whichever fits your workflow best.
In this section
- SetupCreate an M2M token with Communication permissions, then use it to get the sender list, the published lists and the personalized tokens that the email endpoints use.
- SendersGet the list of email senders in Subrite, with sender name, sender email and reply-to address. The sender id is the senderId you use when sending an email.
- TemplatesGet the list of email templates in Subrite, with template type, locale and the MJML template source.
- ConsentsGet the list of consents in Subrite, with title, purpose, frequency, integration ID and where each consent is shown.
- Email listGet a paginated list of emails in Subrite, using the optional page and take query parameters.
- Send emailSend an email to a list (segment) of members right away. The request sets the sender, list, subject and content, with an optional template and host name for unsubscribe links.
- Schedule emailSchedule an email to a list for a later time. Set scheduledAt as an ISO 8601 datetime and optionally a timeZone; without a timeZone the time is treated as UTC.
- Schedule by IDSchedule an email by its ID. Only scheduledAt is required, and timeZone is optional (UTC is used when it is left out). The response includes the communication data.
- Test emailSend a test email to up to 5 recipients. Recipients are always given as an array, and an optional host name sets the domain used in unsubscribe links.
- Test by IDSend a test of an email, identified by its ID, to up to 5 recipients. Recipients are always given as an array.
- Edit emailUpdate an email by its ID with a PATCH request. All fields are optional and only the fields you send are changed. The old route /communications/email/edit/:id is deprecated.
