diff --git a/doc/index.html b/doc/index.html index 5e25e4d..5db3a85 100644 --- a/doc/index.html +++ b/doc/index.html @@ -533,12 +533,12 @@ data-styled.g140[id="sc-global-kJtbWf1"]{content:"sc-global-kJtbWf1,"}/*!sc*/
Array of objects (Recipient)

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

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.

-
Array of objects (Config)

Array of Config objects to change the default behaviour

+
config
Array of strings (Config)

Array of Config objects to change the default behaviour

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"
}
+

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"
}