API Reference/Endpoints
Send an email
POST/api/linkedin/gateway/emails
Sends a new email from a connected mailbox. Set reply_to to thread it onto an existing message instead of starting a new one.
Authentication
Send your personal API key as a bearer token. A missing, malformed or revoked key returns 401.
Body parameters
FieldTypeDescription
account_id *stringThe connected account to send from.
to *arrayRecipients: { identifier, display_name? } each, where identifier is an email address.
body *stringThe message content, as HTML.
subjectstringThe email subject line.
fromobjectOverrides the sending identity, when the mailbox has more than one.
ccarraySame shape as to.
bccarraySame shape as to.
reply_tostringThe id (Warmably or provider) of an earlier email to thread this one onto.
custom_headersarrayExtra headers, { name, value } each. name must start with X-, or be one of a short list of standard headers the engine allows through.
tracking_optionsobject{ opens?, links?, label?, custom_domain? } — turns on open/click tracking for this send.
Warmably's gateway currently only forwards JSON request bodies. The underlying send endpoint also accepts an attachments field for binary file uploads, but that field isn't usable through this route yet — send text-only emails for now.
Response fields
FieldTypeDescription
object"EmailSent"Always this value.
tracking_idstringWarmably's id for this send.
provider_idstring | nullThe mailbox provider's id for the sent message, once known.
provider_immutable_idstring | nullA stable id some providers (Outlook) assign in addition to provider_id.
Errors
·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. The account_id doesn't belong to this key.
