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.
Send a transactional email
cURL
JavaScript
curl -X POST https://api.senditly.ai/v1/transactional/send \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-d '{ ... request json ... }'try {
const response = await fetch('https://api.senditly.ai/v1/transactional/send', {
method: 'POST',
headers: {
Authorization: 'Bearer <API_KEY>',
'Content-Type': 'application/json',
},
body: JSON.stringify({ ... request json ... }),
});
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}Headers
+-Hide 1 propertiesShow 1 properties
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Request
The request body for sending a transactional email. Either `templateId` or `message` must be provided.
+-Hide 10 propertiesShow 10 properties
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.
templateId
string
optional
The id of the template to be used for the email.
message
one of
optional
The data of the message.
+-Hide 1 variantsShow 1 variants
object
"email"
+-Hide 8 propertiesShow 8 properties
type
"email"
required
from
object
required
The sender of the email.
+-Hide 2 propertiesShow 2 properties
name
string
optional
The name of the address.
address
string
required
The email address of the address.
replyTo
object[]
optional
The reply-to email addresses.
+-Hide 2 propertiesShow 2 properties
name
string
optional
The name of the address.
address
string
required
The email address of the address.
subject
string
required
The subject of the email.
preview
string
optional
The preview of the email.
template
MessageTemplate
required
The template of the email.
tracking
object
optional
The tracking of the email.
+-Hide 2 propertiesShow 2 properties
link
boolean
optional
Whether to enable link tracking. By default, `false`.
open
boolean
optional
Whether to enable open tracking. By default, `false`.
raw
object
optional
The raw parts of the email. When this is specified, the template will not be used.
+-Hide 3 propertiesShow 3 properties
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`.
asyncSend
boolean
optional
Whether to send the email asynchronously. By default, `false`.
Response
+-Hide 1 propertiesShow 1 properties
id
string
required
Send a transactional email
cURL
JavaScript
curl -X POST https://api.senditly.ai/v1/transactional/send \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-d '{ ... request json ... }'try {
const response = await fetch('https://api.senditly.ai/v1/transactional/send', {
method: 'POST',
headers: {
Authorization: 'Bearer <API_KEY>',
'Content-Type': 'application/json',
},
body: JSON.stringify({ ... request json ... }),
});
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}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.
Get the status of a transactional email
cURL
JavaScript
curl -X GET https://api.senditly.ai/v1/transactional/send/:id/status \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"try {
const response = await fetch('https://api.senditly.ai/v1/transactional/send/:id/status', {
method: 'GET',
headers: {
Authorization: 'Bearer <API_KEY>',
},
body: JSON.stringify({ ... request json ... }),
});
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}Headers
+-Hide 1 propertiesShow 1 properties
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
+-Hide 1 propertiesShow 1 properties
id
string
required
The idempotency key for the transactional.
Response
+-Hide 4 propertiesShow 4 properties
id
string
required
status
string
required
error
string
optional
sentAt
string
optional
A date string in ISO 8601 format when the email was sent.
Get the status of a transactional email
cURL
JavaScript
curl -X GET https://api.senditly.ai/v1/transactional/send/:id/status \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"try {
const response = await fetch('https://api.senditly.ai/v1/transactional/send/:id/status', {
method: 'GET',
headers: {
Authorization: 'Bearer <API_KEY>',
},
body: JSON.stringify({ ... request json ... }),
});
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
Senditly© 2025 Unbounded Pioneering株式会社
プライバシーポリシー利用規約スパムメール対策ポリシーデータ処理契約(DPA)情報セキュリティ基本方針サービスレベルアグリーメント(SLA)