BLbluehive-health

Email

Send Templated Email

Changed on Oct 16, 2026

Send an email using a registered template. Internal use only.

post/v1/email/templates/{name}/send

Request

Base URL
https://api.bluehive.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/bluehive-health/apis/bluehive-api/docs/v1/email/templates/:name/send/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

Template name

Request body

tostring[] required

Array of recipient email addresses

variablesobject required

Template variables to interpolate

Response

Default Response

successboolean required

True if all emails were sent successfully, false if any failed

templateUsedstring required

Name of the template used

Changes

Oct 16, 2026a8bcbdf02e33 Revision changes
- warning
  removed the request property
Mar 17, 20264abf46539e83 Revision changes
- breaking
  added the new required request property

Operation history (3 revisions)