Skip to main content
Resend Docs
current

Search documentation

Type to search this documentation.

On this pageOverview

Update Inbox

Update the internal inbox name or the name recipients see when sending.

At least one of name or friendly_name is required.

The Inbox ID.

  • name (string) — New internal name for the inbox. Recipients do not see it.

The name recipients see when mail is sent from this inbox. A plain name, not a Name <email> address.

Node.js
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.inboxes.update(
  'b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1',
  { name: 'Customer Support', friendlyName: 'Ada from Support' },
);
cURL
curl -X PATCH 'https://api.resend.com/inboxes/b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1' \
     -H 'Authorization: Bearer re_xxxxxxxxx' \
     -H 'Content-Type: application/json' \
     -d $'{
  "name": "Customer Support",
  "friendly_name": "Ada from Support"
}'
CLI
resend inboxes update b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1 \
  --name "Customer Support" \
  --friendly_name "Ada from Support"
Response
{
  "object": "inbox",
  "id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
}
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu