diff --git a/doc/index.html b/doc/index.html index c993651..069a2ac 100644 --- a/doc/index.html +++ b/doc/index.html @@ -527,6 +527,7 @@ data-styled.g140[id="sc-global-kJtbWf1"]{content:"sc-global-kJtbWf1,"}/*!sc*/ htmlurl
string

String containing the URL to a file containing the HTML content of the email. Ignored (but still validated) if html if provided. If both htmlurl and text or texturl are provided, will create a multi-part MIME message.

text
string

String containing the plain text content of the email. Takes precedence over texturl if provided. If both text and html or htmlurl are provided, will create a multi-part MIME message.

texturl
string

String containing the URL to a file containing the plain text content of the email. Ignored (but still validated) if text is provided. If both texturl and html or htmlurl are provided, will create a multi-part MIME message.

+
object

Recipient object to be used as "From:" address for the email

required
Array of objects (Recipient)

Array of Recipient objects to be used as "To:" addresses for the email

Array of objects (Recipient)

Array of Recipient objects to be used as "CC:" addresses for the email

Array of objects (Recipient)

Array of Recipient objects to be used as "BCC:" addresses for the email

@@ -534,9 +535,9 @@ data-styled.g140[id="sc-global-kJtbWf1"]{content:"sc-global-kJtbWf1,"}/*!sc*/
Array of objects (Placeholder)

Array of Placeholder objects. Any occurrences of {PLACEHOLDER_NAME} (name in all caps enclosed with curly brackets) in the email's HTML or plain text will be replaced by value.

key
required
string

API key to authenticate request with

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "html": "string",
  • "htmlurl": "string",
  • "text": "string",
  • "texturl": "string",
  • "recipients":
    [
    ],
  • "ccs":
    [
    ],
  • "bccs":
    [
    ],
  • "attachments":
    [
    ],
  • "placeholders":
    [
    ],
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "error": "string"
}
+

Request samples

Content type
application/json
{
  • "subject": "string",
  • "html": "string",
  • "htmlurl": "string",
  • "text": "string",
  • "texturl": "string",
  • "sender":
    {
    },
  • "recipients":
    [
    ],
  • "ccs":
    [
    ],
  • "bccs":
    [
    ],
  • "attachments":
    [
    ],
  • "placeholders":
    [
    ],
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "error": "string"
}