Skip to main content
PUT

Path Parameters

string
required
The domain ID the inbox belongs to.
string
required
The inbox ID (UUID) to update.

Body

All body fields are optional. Only provided fields are updated; others retain their existing values.
string
New local part for the inbox address. Accepts either local_part or localPart.
object
Updated webhook configuration. Replaces the entire existing webhook config.
string
New inbox status. Example values: "active", "inactive".

Response

object
The updated inbox object. Same shape as Get inbox.
Last modified on March 19, 2026