Create a topic
A topic is what contacts subscribe to, built on categories: emails sent with category equal to the topic's key are about it, so contacts who opted out (or, for an opt_out topic, never opted in) are skipped. Public topics show in the preference center.
bearerAuthAuthorizationBearer <token>A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.
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.
"2026-10-10"application/json- body
- body
- …
key*stringThe category of the emails about this topic. Can't change.
^[A-Za-z0-9_-]{1,256}$name*stringShown in the preference center.
1 <= length <= 200description?|Shown in the preference center under its name. null: none.
length <= 500default_subscription*stringopt_in: every subscribed contact gets the topic's emails unless they opt out. opt_out: only contacts who opted in do.
"opt_in""opt_out"visibility?stringprivate topics never show in the preference center (default public).
"public""private"position?integerOrder in the preference center (ascending).
0 <= value <= 1000The new topic.
application/json- response
- response
- …
object*"topic""topic"id*stringkey*stringThe category of the emails about this topic. Can't change.
name*stringShown in the preference center.
description*|Shown in the preference center under its name. null: none.
default_subscription*stringopt_in: every subscribed contact gets the topic's emails unless they opt out. opt_out: only contacts who opted in do.
"opt_in""opt_out"visibility*stringprivate topics never show in the preference center.
"public""private"position*integerOrder in the preference center (ascending).
created_at*stringdate-timeupdated_at*stringdate-timeimport { Coss } from "coss";const coss = new Coss({ apiKey: process.env.COSS_API_KEY, baseUrl: "https://api.coss.com",});const { data, error } = await coss.email.topics.create({ key: "newsletter", name: "Newsletter", default_subscription: "opt_in",});{ "object": "topic", "id": "topic_01k7c8m4q2f3e9v6t5r1n0p8yz", "key": "newsletter", "name": "Newsletter", "description": "Monthly product news.", "default_subscription": "opt_in", "visibility": "public", "position": 0, "created_at": "2026-10-10T12:00:00.000Z", "updated_at": "2026-10-10T12:00:00.000Z"}