{
"id": "<string>",
"from": {
"name": "Support Team",
"address": "team@example.com"
},
"to": [
{
"name": "Support Team",
"address": "team@example.com"
}
],
"cc": [
{
"name": "Support Team",
"address": "team@example.com"
}
],
"bcc": [
{
"name": "Support Team",
"address": "team@example.com"
}
],
"replyTo": [
{
"name": "Support Team",
"address": "team@example.com"
}
],
"subject": "<string>",
"summary": "This is a summary.",
"contentType": "text/html",
"externalId": "<string>",
"callbackUrl": "https://httpbin.org/anything?tag=api-email",
"createTime": "2022-06-01T12:00:00.000Z",
"totalRecipients": 3,
"totalPrice": 0.0085,
"currency": "USD"
}Send an email
Sends an outbound email message.
{
"id": "<string>",
"from": {
"name": "Support Team",
"address": "team@example.com"
},
"to": [
{
"name": "Support Team",
"address": "team@example.com"
}
],
"cc": [
{
"name": "Support Team",
"address": "team@example.com"
}
],
"bcc": [
{
"name": "Support Team",
"address": "team@example.com"
}
],
"replyTo": [
{
"name": "Support Team",
"address": "team@example.com"
}
],
"subject": "<string>",
"summary": "This is a summary.",
"contentType": "text/html",
"externalId": "<string>",
"callbackUrl": "https://httpbin.org/anything?tag=api-email",
"createTime": "2022-06-01T12:00:00.000Z",
"totalRecipients": 3,
"totalPrice": 0.0085,
"currency": "USD"
}Authorizations
Body
- The sender's email. Its domain should be one that has been registered and activated in your account.
- The sender's email address is required while the sender's name is optional. For example, both
support@example.comandSender<support@example.com>work.
"SupportTeam<support@example.com>"
- The intended recipients' email addresses.
- Supports a comma-separated list of one or more addresses. Max items: 100.
"to1@example.com,Nick<to2@example.com>"
The email subject, which contains a short string identifying the topic of the message. Max length: 255.
255- The email body. Max size: 150 KB.
- Variables in the form of
#var_1#are supported, they should be used together with thevariablesparameter. Variable keys only support letters, digits, and the underline character (_). - You can use the Test Templates provided by YCloud for testing.
"This is a test message from #nick#."
The MIME type of the email content (text/html or text/plain). Be aware that We won't count click and open events for the type text/plain.
text/html, text/plain - The variable key-value pairs that will replace the variable placeholders in
contentfor each recipient. Variable keys are those that are wrapped with#as placeholders (e.g.,#var_1#) incontent. The placeholders will be replaced by variable values when sending the email. - The size of the array must be the same as the number of recipients in
to. Be aware thatccandbccaddresses are excluded, and they can not receive emails that contain variables. - This parameter's size will be calculated together with the parameter
content. The whole size must not exceed 150 KB.
Show child attributes
Show child attributes
Recipients who will receive a copy of the email.
"cc1@example.com,Nick<cc2@example.com>"
Recipients who will receive a blind carbon copy of the email.
"bcc1@example.com,Nick<bcc2@example.com>"
If this field exists, then the reply should go to the addresses indicated in that field and not to the address(es) indicated in the from field.
This is a summary of your email. Max length: 70.
70"This is a summary."
A unique (recommended) string to reference the object. This can be an order number or similar, and can be used to reconcile the object with your internal systems.
Delivery report URL. You can provide a URL, and we will push the updated status report to your server in time. e.g., https://httpbin.org/anything?tag=api. Note: We recommend configuring Webhook Endpoints instead.
"https://httpbin.org/anything?tag=api-email"
Response
The request is successfully accepted.
Unique ID for the object.
6 - 128The sender's email address.
Show child attributes
Show child attributes
The intended recipients' email addresses.
Show child attributes
Show child attributes
Recipients who will receive a copy of the email.
Show child attributes
Show child attributes
Recipients who will receive a blind carbon copy of the email.
Show child attributes
Show child attributes
If this field exists, then the reply should go to the addresses indicated in that field and not to the address(es) indicated in the from field.
Show child attributes
Show child attributes
The email subject, which contains a short string identifying the topic of the message.
255This is a summary of your email. Max length: 70.
70"This is a summary."
The MIME type of the email content (text/html or text/plain). Be aware that We won't count click and open events for the type text/plain.
text/html, text/plain A unique (recommended) string to reference the object. This can be an order number or similar, and can be used to reconcile the object with your internal systems.
Delivery report URL. You can provide a URL, and we will push the updated status report to your server in time. e.g., https://httpbin.org/anything?tag=api. Note: We recommend configuring Webhook Endpoints instead.
"https://httpbin.org/anything?tag=api-email"
Total recipients of this message, including to, cc and bcc.
3
Total price of this message.
0.0085
Price currency. ISO 4217 currency code.
"USD"