coss.comdocs

Update an inbox

PATCH
/v1/inboxes/{inbox_id}

Changes the name messages from the inbox are sent with. Its address never changes.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

inbox_id*string

The inbox'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
display_name?|

The name messages are sent with; null sends with the bare address.

Response Body

The updated inbox.

application/json
  1. response
object*"inbox"
Value in"inbox"
id*string
address*string

The inbox's email address (username@domain).

username*string
domain*string
kind*string

managed: at the environment's own domain under coss.com's inbound domain (no DNS setup). domain: at one of the environment's receiving domains.

Value in"managed""domain"
display_name*|

The name messages from the inbox are sent with.

client_id*|

Your own id for the inbox, e.g. your agent's or user's (unique per environment).

can_send*boolean

Whether messages can be sent from the inbox. Inboxes at coss.com's inbound domain only receive in live environments: create the inbox at a receiving domain under one of your verified domains to send from it.

sandbox*boolean

Whether it belongs to a sandbox environment.

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.inboxes.update("inbox_01k7c8m4q2f3e9v6t5r1n0p8yz", {  display_name: "Acme Help",});
{  "object": "inbox",  "id": "inbox_01k7c8m4q2f3e9v6t5r1n0p8yz",  "address": "support-agent@k3j9x2m7qp4l.inbound.coss.com",  "username": "support-agent",  "domain": "k3j9x2m7qp4l.inbound.coss.com",  "kind": "managed",  "display_name": "Acme Support",  "client_id": "agent-42",  "can_send": true,  "sandbox": true,  "created_at": "2026-10-10T12:00:00.000Z",  "updated_at": "2026-10-10T12:00:00.000Z"}