INinstantly
Email

Send a test email

Changed on

Send a preview/test email without creating an email entity in Unibox. Rate limit: 10 requests per minute per workspace.

Requires one of the following scopes: emails:create, emails:all, all:create, all:all

post/api/v2/emails/test

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/emails/test
  • Auth
    HTTP bearer

Request body

eaccountstring required

The email account that will be used to send this email. It has to be an email account connected to your workspace.

to_address_email_liststring required

Comma-separated list of recipients that will receive the test email.

subjectstring required

Subject line of the test email.

Example request

{
  "eaccount": "jondoe@example.com",
  "to_address_email_list": "recipient@example.com,recipient2@example.com",
  "subject": "Test email subject",
  "body": {
    "html": "This is a test email.<br/><br/>Second line."
  }
}

Response

Default Response

OR

Example response

{
  "status": "success"
}

Changes

  • c781051105a8Revision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status