Send
Preview
POST
https://api.senditly.ai/v1/transactional/send
Send a transactional email
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Request
id
string
optional
The idempotency key for the transactional. If provided, no duplicate check will be performed before sending.
to
string
required
The email address or contact id of the recipient.
message
union
required
The data of the message.
email
type
literal
required
from
object
required
The sender of the email.
name
string
optional
The name of the address.
address
string
required
The email address of the address.
replyTo
array
optional
The reply-to email addresses.
subject
string
required
The subject of the email.
preview
string
optional
The preview of the email.
template
ref
required
The template of the email.
raw
object
optional
The raw parts of the email. When this is specified, the template will not be used.
html
string
optional
The raw HTML part of the email. When this is specified, the template will not be used.
text
string
optional
The raw TEXT part of the email. When this is specified, the template will not be used.
listUnsubscribe
string
optional
The raw list unsubscribe url of the email. When this is specified, the template will not be used.
variables
json
optional
mailingListId
string
optional
The mailing list id to be used for the email. If not provided, the email will be sent as a transactional email, and an unsubscribe link won't be included. The transactional email should not be promotional. If provided, the email will be sent to the target subscribed to the mailing list, and an unsubscribe link will be included. If the target is opted out from the mailing list, the email won't be sent.
locale
enum
optional
The locale.
failOnTimeout
boolean
optional
Whether to fail the request if the email is not sent within a fixed time. By default, `false`.
addToContacts
boolean
optional
Whether to add the recipient to the contact list if the recipient is not already in the contact list. By default, `false`.
tracking
object
optional
The setting of the tracking.
link
boolean
optional
Whether to enable link tracking. By default, `false`.
open
boolean
optional
Whether to enable open tracking. By default, `false`.
asyncSend
boolean
optional
Whether to send the email asynchronously. By default, `false`.
Response
id
string
required
RetrieveStatus
Preview
GET
https://api.senditly.ai/v1/transactional/send/:id/status
Get the status of a transactional email
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
id
string
required
The idempotency key for the transactional.
Response
id
string
required
status
string
required
error
string
optional
sentAt
string
optional
A date string in ISO 8601 format when the email was sent.
Senditly© 2025 Unbounded Pioneering株式会社
プライバシーポリシー利用規約スパムメール対策ポリシーデータ処理契約(DPA)情報セキュリティ基本方針サービスレベルアグリーメント(SLA)