Overview

Send Emails allows partners to automate email delivery through the CiiRUS-API. This endpoint enables the sending of emails with customizable content, recipient details, and sender information, providing seamless integration into partner systems.

Endpoints Available

Method	Endpoint	Description
PUT	v2024.07.31/emails	Send emails programmatically through the Partner-API with customizable content, recipients, and sender details

Body Parameters

Parameter	Required / Optional	Description	Data Type
`"email_content"`	Required	The main content or body of the email message	string
`"email_html_content"`	Optional	The HTML-formatted content of the email, which can be used to create rich and styled email messages	string
`"email_subject"`	Required	The subject or title of the email	string
`"to_email_address"`	Required	The recipient's email address to which the email will be sent	string
`"to_email_addresses"`	Optional	An array of recipient email addresses, allowing multiple recipients for the same email	array
`"from_email_address"`	Required	The sender's email address, specifying the source of the email	string
`"from_name"`	Required	The sender's name or identifier, which is displayed in the "From" field of the email	string

Response Definition

Response Item	Description	Data Type
`"user_id"`	The unique identifier associated with the user who initiated the email-sending process	int
`"date_added"`	The date and time when the email request was initially added to the system	date-time
`"date_sent"`	The date and time when the email was successfully sent	date-time
`"mandrill_message_id"`	The unique identifier assigned to the email message by the email delivery service	string
`"email_content"`	The content of the email message, which can vary according to the specific email request	string
`"email_subject"`	The subject line of the email message	string
`"to_email_address"`	The email address of the recipient to whom the email was sent	string
`"from_email_address"`	The sender's email address, typically representing the partner or system initiating the email	string
`"from_name"`	The name associated with the sender, providing a recognizable identity for the sender of the email	string

Sample Request

curl --request PUT \
     --url https://api.ciiruspartners.com/v2024.07.31/emails \
     --header 'Authorization: Basic {APIUsername:APIPassword}' \
     --data '
[
  {
    "email_content": "This is some test email content, to provide context for an example request.",
    "email_subject": "Test Email Subject",
    "to_email_address": "[email protected]",
    "from_email_address": "[email protected]",
    "from_name": "Test User"
  }
]
'

Sample Response

[
  {
    "user_id": 42330,
    "date_added": "2023-11-02T19:21:00.5046025Z",
    "date_sent": "2023-11-02T19:21:00.5047274Z",
    "mandrill_message_id": "e29cd98656cf4e5da69627b66a3a93e3",
    "email_content": "This is some test email content, to provide contect for an example request.",
    "email_subject": "Test Email Subject",
    "to_email_address": "[email protected]",
    "from_email_address": "[email protected]",
    "from_name": "Test User"
  }
]