Skip to content
Documentation

send test email

POST
/api/v1/workspaces/{workspace_id}/test_emails
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/test_emails \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "recipient_ids": [ 1 ], "test_list_ids": [ 1 ], "conditional_selections": [ { "conditional_id": 12345, "mode": "all", "branch_key": "gold" } ], "email_id": 1, "locale": "en-GB" }'

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”
Media typeapplication/json
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

The id of a saved conditional, or an inline conditional addressed by its owner: inline:<component_instance_id> for a component instance, or inline:subject / inline:preheader.

integer | string
Example
12345
mode
required
string
Allowed values: all none branch
Example
branch
branch_key
string | null
Example
gold
email_id
required
integer
locale
required

A BCP 47 language tag identifying the language and region of a piece of content. Must carry both a language and a region subtag, and must be in canonical case (lowercase language, titlecase script, uppercase region) — en-GB, not en-gb or en_GB. The region may be a UN M.49 code, so en-001 (world) is valid.

string
Example
en-GB

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
id
required
integer
email_id
required
integer
locale
string
organization_id
required
integer
recipient_ids
required
Array<integer>
test_list_ids
required
Array<integer>
conditional_selections
required
Array<object>
object
conditional_id
required

The id of a saved conditional, or an inline conditional addressed by its owner: inline:<component_instance_id> for a component instance, or inline:subject / inline:preheader.

integer | string
mode
required
string
Allowed values: all none branch
branch_key
string | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example
{
  "id": 12345,
  "email_id": 12345,
  "locale": "en-US",
  "organization_id": 12345,
  "recipient_ids": [
    12345
  ],
  "test_list_ids": [
    12345
  ],
  "conditional_selections": [
    {
      "conditional_id": 12345,
      "mode": "all",
      "branch_key": "gold"
    }
  ],
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

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