Send Calendar Email

post

https://api.aurorasendcloud.com/api/mail/sendcalendar

Send calendar invitations containing meeting information, supporting cancellation/updates of calendars. Requires the account to be in the sendcalendar whitelist (APIV2_SENDCALENDAR_USERS); unauthorized accounts get GLOBAL_NO_PRIVILEDGE_USE_THE_API (40018). Region endpoint does not change the permission requirement.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

from

string

required

Sender email address (e.g., [email protected]). After configuring DMARC, SendCloud uses the current domain as the suffix of "from". Required; empty returns MAIL_FROM_NOTNULL (40801)

string

required

Recipient email addresses (separated by semicolons, e.g., [email protected];[email protected]). Required; empty returns MAIL_TOS_NOTNULL (40805)

subject

string

required

Email subject. Required; empty returns MAIL_SUBJECT_NOTNULL (40808)

html

string

Email content in text/html format. Required if plain is empty

fromName

string

Sender name (shown as "EXAMPLE customer [email protected]")

string

CC addresses (separated by semicolons)

bcc

string

BCC addresses (separated by semicolons)

replyTo

string

Default reply addresses (separated by semicolons, max 3). Supports plain email or display-name format (e.g., "ASC <[email protected]>"). Defaults to "from" if empty or null

labelName

string

length ≤ 255

Label for this send. Automatically created if not existing in the account. Must contain at least one letter or digit (letters/digits/CJK allowed); pure-symbol names return LABEL_NAME_CHARSET_INVALID (40118). Max length 255 characters; overlong returns LABEL_NAME_FORMATERROR (40105)

headers

string

Email headers in JSON format (e.g., {"header1": "value1", "header2": "value2"})

attachments

array of files

Email attachments. Must use multipart/form-data when submitting. The size of attachments is 10MB by default. Contact customer service for special needs. Omit this field when there are no attachments; do not send a literal [] (multipart cannot encode a zero-file array and it triggers a server error).

xsmtpapi

string

SMTP extension. See → X-SMTPAPI for details

plain

string

Email content in text/plain format. Required if html is empty

sendRequestId

string

Max 128 characters; overlong returns GLOBAL_REQUESTID_TOOLONG (40031). Duplicate values within 1 hour (3600s) are only processed once and return GLOBAL_DUPLICATE_REQUEST (40000)

respEmailId

string

enum

Defaults to true

Whether to return emailId. Returns a list for multiple recipients

Allowed:

startTime

date-time

required

Meeting start time (formatted as yyyy-MM-dd HH:mm:ss). Required; empty returns MAIL_CALENDAR_STARTTIME_NOTNULL (40832)

endTime

date-time

required

Meeting end time (formatted as yyyy-MM-dd HH:mm:ss). Required; empty returns MAIL_CALENDAR_ENDTIME_NOTNULL (40834)

title

string

required

Meeting title. Required; empty returns MAIL_CALENDAR_TITLE_NOTNULL (40836)

organizerName

string

required

Organizer name

organizerEmail

string

required

Organizer email address

location

string

required

Meeting location

description

string

Meeting description

participatorNames

string

required

Participant names (separated by semicolons). Required; count must equal participatorEmails, otherwise returns MAIL_CALENDAR_PARTICIPATOREMAILS_PARTICIPATORNAMES_NOTEQUAL (40850)

participatorEmails

string

required

Participant email addresses (separated by semicolons). Required (including cancel/update, used to build the attendee list); empty returns MAIL_CALENDAR_PARTICIPATOREMAILS_NOTNULL (40848). Count must equal participatorNames (40850)

uid

string

Required for cancelling/updating calendar. Returned in the first send request

isCancel

string

enum

Defaults to false

Whether to cancel the calendar

Allowed:

isUpdate

string

enum

Defaults to false

Whether to update the calendar

Allowed:

Responses

200Calendar invitation sent successfully

400Business error. The server returns HTTP 200 with the business code in statusCode; the HTTP status here is a documentation placeholder.