coss.comdocs

Send a test of a broadcast

POST
/v1/broadcasts/{id}/test

Sends its content to up to 5 addresses as ordinary marketing emails (subject prefixed [Test]), filled with contact's values or the fallbacks. They count like any send.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Path Parameters

id*string

The broadcast's id.

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Request Body

application/json
  1. body
to*array<string>
Items1 <= items <= 5
contact?string

A contact (id or address) whose values fill the template; default: fallbacks.

Response Body

The test emails.

application/json
  1. response
object*"broadcast_test"
Value in"broadcast_test"
email_ids*array<string>
import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.email.broadcasts.test("bcast_01k7c8m4q2f3e9v6t5r1n0p8yz", {  to: [    "me@acme.com",  ],});
{  "object": "broadcast_test",  "email_ids": [    "email_01k7c8m4q2f3e9v6t5r1n0p8yz"  ]}