coss.comdocs

Update a sub-account

PATCH
/v1/subaccounts/{subaccount}

Changes the name, uid, metadata, status or quotas. Fields left out keep their value; status: "disabled" refuses its sends until it is active again.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

subaccount*string

The sub-account's id (sub_…) or your uid for it.

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
name?string
Length1 <= length <= 256
uid?|

null removes it.

metadata?

Replaces the metadata.

status?string

disabled refuses its sends until it is active again.

Value in"active""disabled"
quotas?

Fields left out keep their value; null removes a quota.

Response Body

The sub-account.

application/json
  1. response
object*"subaccount"
Value in"subaccount"
id*string
uid*|

Your own id for it (e.g. your user's id), unique in the environment. Every path and send that takes a sub-account accepts its id or its uid.

name*string
metadata*
status*string

disabled: you turned it off (its sends are refused). deleting: its domains are being released.

Value in"active""disabled""deleting"
quotas*
reputation*
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
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.subaccounts.update("user_8812", {  status: "disabled",});
{  "object": "subaccount",  "id": "sub_01k7c8m4q2f3e9v6t5r1n0p8yz",  "uid": "user_8812",  "name": "Acme Bakery",  "metadata": {    "plan": "pro"  },  "status": "active",  "quotas": {    "recipients_per_day": 5000,    "recipients_per_second": 5,    "burst": 50  },  "reputation": {    "status": "good",    "trigger": null,    "changed_at": null,    "reinstated_at": null  },  "created_at": "2026-01-15T09:30:00.000Z",  "updated_at": "2026-01-15T09:30:00.000Z"}