Skip to content
Documentation

send test email

POST
/api/v1/workspaces/{workspace_id}/test_emails

Sends a test email.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

Request Body

Section titled “Request Body ”
object
recipient_ids
required

IDs of users to send the test email to.

Array<integer>
test_list_ids

IDs of test lists to send the test email to.

Array<integer>
conditional_selections
required

Conditional branch selections to use when rendering the test email.

Array<object>
object
conditional_id
required
integer
Example
12345
mode
required
string
Allowed values: all none branch
Example
branch
branch_key
string
nullable
Example
gold
email_id
required
integer
locale
required
string
Allowed values: ar-SA bn-BD bn-IN ca-ES cs-CZ da-DK de-AT de-CH de-DE el-GR en-AU en-CA en-GB en-IE en-IN en-NZ en-US en-ZA es-AR es-CL es-CO es-ES es-MX es-US fi-FI fr-BE fr-CA fr-CH fr-FR he-IL hi-IN hu-HU id-ID it-CH it-IT ja-JP ko-KR nl-BE nl-NL no-NO pl-PL pt-BR pt-PT ro-RO ru-RU sk-SK sv-SE ta-IN ta-LK th-TH tr-TR zh-CN zh-HK
Example
en-US

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful

object
id
required
integer
Example
12345
email_id
required
integer
Example
12345
locale
string
Example
en-US
organization_id
required
integer
Example
12345
recipient_ids
required
Array<integer>
test_list_ids
required
Array<integer>
conditional_selections
required
Array<object>
object
conditional_id
required
integer
Example
12345
mode
required
string
Allowed values: all none branch
Example
branch
branch_key
string
nullable
Example
gold
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

422

Section titled “422 ”

Unprocessable Entity

object
message
required
string
Example
Failed to save
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}