Update Inbox
PATCH
/
inboxes
/
:inbox_id
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 -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"
}'resend inboxes update b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1 \
--name "Customer Support" \
--friendly_name "Ada from Support"{
"object": "inbox",
"id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
}At least one of name or friendly_name is required.
Path Parameters
Section titled “Path Parameters”Body Parameters
Section titled “Body Parameters”string
New internal name for the inbox. Recipients do not see it.
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 -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"
}'resend inboxes update b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1 \
--name "Customer Support" \
--friendly_name "Ada from Support"{
"object": "inbox",
"id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1"
}Was this page helpful?
⌘I