Send an email

post https://api.ycloud.com/v2/emails

Sends an outbound email message.

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

from

string

required

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.com and Sender<support@example.com> work.

string

required

The intended recipients' email addresses.
Supports a comma-separated list of one or more addresses. Max items: 100.

subject

string

required

length ≤ 255

The email subject, which contains a short string identifying the topic of the message. Max length: 255.

content

string

required

The email body. Max size: 150 KB.
Variables in the form of #var_1# are supported, they should be used together with the variables parameter. Variable keys only support letters, digits, and the underline character (_).
You can use the Test Templates provided by YCloud for testing.

contentType

string

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.

variables

array of objects

The variable key-value pairs that will replace the variable placeholders in content for each recipient. Variable keys are those that are wrapped with # as placeholders (e.g., #var_1#) in content. 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 that cc and bcc addresses 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.

variables

string

Recipients who will receive a copy of the email.

bcc

string

Recipients who will receive a blind carbon copy of the email.

replyTo

string

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.

summary

string

length ≤ 70

This is a summary of your email. Max length: 70.

externalId

string

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.

callbackUrl

string

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.

Response

Response body

object

string

required

length between 6 and 128

Unique ID for the object.

from

object

The sender's email address.

name

string

Name of the mailbox.

address

string

Address of the mailbox.

array of objects

The intended recipients' email addresses.

object

name

string

Name of the mailbox.

address

string

Address of the mailbox.

array of objects

Recipients who will receive a copy of the email.

object

name

string

Name of the mailbox.

address

string

Address of the mailbox.

bcc

array of objects

Recipients who will receive a blind carbon copy of the email.

bcc

object

name

string

Name of the mailbox.

address

string

Address of the mailbox.

replyTo

array of objects

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.

replyTo

object

name

string

Name of the mailbox.

address

string

Address of the mailbox.

subject

string

length ≤ 255

The email subject, which contains a short string identifying the topic of the message.

summary

string

length ≤ 70

This is a summary of your email. Max length: 70.

contentType

string

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

externalId

string

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.

callbackUrl

string

createTime

date-time

The time at which this message was created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

totalRecipients

int32

Total recipients of this message, including to, cc and bcc.

totalPrice

double

Total price of this message.

currency

string

Price currency. ISO 4217 currency code.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.ycloud.com/v2/emails \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
40
}
1
{
2
  "id": "string",
3
  "from": {
4
    "name": "Support Team",
5
    "address": "team@example.com"
6
  },
7
  "to": [
8
    {
9
      "name": "Support Team",
10
      "address": "team@example.com"
11
    }
12
  ],
13
  "cc": [
14
    {
15
      "name": "Support Team",
16
      "address": "team@example.com"
17
    }
18
  ],
19
  "bcc": [
20
    {
21
      "name": "Support Team",
22
      "address": "team@example.com"
23
    }
24
  ],
25
  "replyTo": [

200The request is successfully accepted.