diff --git a/doc/index.html b/doc/index.html index 317b6bb..1580e18 100644 --- a/doc/index.html +++ b/doc/index.html @@ -534,11 +534,15 @@ data-styled.g140[id="sc-global-kJtbWf1"]{content:"sc-global-kJtbWf1,"}/*!sc*/
Array of objects (Attachment)

Array of Attachment objects to be attached to the email

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.

config
Array of strings (Config)

Array of Config keys to change the default behaviour

+
    +
  • noconversion - Do not automatically convert HTML to plain text if no plain text message is explicitly given
  • +
  • ignoredlfails - If an attachment fails to download, just leave it out and continue processing the message
  • +
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",
  • "sender":
    {
    },
  • "recipients":
    [
    ],
  • "ccs":
    [
    ],
  • "bccs":
    [
    ],
  • "attachments":
    [
    ],
  • "placeholders":
    [
    ],
  • "config":
    [
    ],
  • "key": "string"
}

Response samples

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