PATCH
/inboxes/{inbox_id}Update an inbox
Updates an inbox's internal name or the sender name recipients see. Provide at least one of name or from_name; omitted values remain unchanged.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
inbox_idstringrequired
The UUID of the inbox to update; an email address is not accepted.
Provide at least one of the inbox's internal name or sender name.
namestringrequired
New internal name for the inbox. Recipients do not see it. Between 1 and 64 characters after trimming.
from_namestringoptional
The name recipients see when mail is sent from this inbox. A plain name, not a `Name <email>` address. Max 78 characters. It cannot contain a colon, `<`, `>`, line breaks, or other control characters. An email address inside the name must be on a domain the team has verified for sending. An empty string removes it.
200Returns the inbox object type and the inbox ID.
objectstringrequired
The object type.
idstringrequired
The ID of the inbox.
Error handling
The inbox_id path parameter must be a UUID. Provide at least one of name or from_name; name must contain 1 to 64 characters after trimming, and from_name must be a plain name of at most 78 characters without a colon, angle brackets, line breaks, or control characters.