Inboxes

Update an inbox

Change the internal name or the name recipients see. At least one of name or from_name. from_name: null clears it (not in Resend). Requires the domain:write scope on a key created by a team owner or admin.

patch/v1/inboxes/{inbox_id}

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/inboxes/{inbox_id}
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

The inbox id or its email address

Request body

namestring
from_namestring nullable

Response

Updated

objectstring
idstring

Example response

{
  "object": "inbox"
}

Changes

No recorded changes to this operation across all 1 revision of this API.