> ## Documentation Index > Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt > Use this file to discover all available pages before exploring further. # Update a Mailbox > Updates editable fields: display name, signature, reply-to, and the shared / centralized-inbox flags. Connection state (provider, grant, permission type) is set by the auth flow, not here. Permissions: the owner can update their own delegated mailbox; shared mailboxes can be updated by any org member; centralized inboxes require an org admin. ## OpenAPI ````yaml https://api.stuut.ai/openapi.json patch /v2/mailboxes/{mailbox_id} openapi: 3.1.0 info: title: Stuut API termsOfService: https://stuut.ai/terms-and-conditions contact: name: Stuut Support url: https://stuut.ai/ email: devs@stuut.co version: 2.0.0 servers: [] security: - HTTPBearer: [] tags: - name: adjustments description: Operations for managing payment adjustments (fees, discounts, write-offs). x-displayName: Adjustments - name: aether description: Operations for aether. x-displayName: Aether - name: analytics description: Operations for retrieving analytics and dashboard data. x-displayName: Analytics - name: assistant description: Operations for the in-app chat assistant. x-displayName: Assistant - name: audit-log description: Operations for retrieving the organization's audit log. x-displayName: Audit Log - name: bank-accounts description: Operations for retrieving and managing bank accounts. x-displayName: Bank Accounts - name: bank-statements description: Operations for retrieving and managing bank statements. x-displayName: Bank Statements - name: bank-transactions description: Operations for retrieving and managing bank transactions. x-displayName: Bank Transactions - name: business-units description: Operations for listing and managing business units. x-displayName: Business Units - name: call-agent description: >- Operations for initiating and managing real-time voice calls with partners. x-displayName: Call Agent - name: calls description: Operations for retrieving and managing voice call records. x-displayName: Calls - name: cash-app description: Operations for cash application — matching incoming payments to invoices. x-displayName: Cash Application - name: chats description: Operations for managing chat conversations. x-displayName: Chats - name: cnam-registration description: Operations for managing CNAM (caller ID name) registration. x-displayName: CNAM Registration - name: credit-memos description: Operations for retrieving and searching credit memos. x-displayName: Credit Memos - name: custom-table-templates description: >- Operations for managing custom table templates used in email template variables. x-displayName: Custom Table Templates - name: customer-segments description: Operations for managing customer segments. x-displayName: Customer Segments - name: deductions-knowledge description: Operations for managing deduction processing knowledge entries. x-displayName: Deductions Knowledge - name: email-threads description: Operations for managing email threads. x-displayName: Email Threads - name: emails description: Operations for retrieving and managing emails. x-displayName: Emails - name: exports description: Operations for requesting and retrieving async data exports. x-displayName: Exports - name: integrations description: >- Operations for managing integrations with external systems (e.g. ERP, CRM, etc.). x-displayName: Integrations - name: internal-contacts description: >- Operations for managing internal contacts (CSMs, account managers, etc.) and their assignments to partners. x-displayName: Internal Contacts - name: invoices description: Operations for retrieving and managing invoices. x-displayName: Invoices - name: kyb description: Operations for Know Your Business (KYB) verification. x-displayName: KYB - name: ledger-accounts description: Operations for retrieving and managing ledger accounts. x-displayName: Ledger Accounts - name: mailbox-settings description: >- Operations for an organization's mailbox provider configuration: Microsoft admin consent, shared-mailbox discovery, and provider health. x-displayName: Mailbox Settings - name: mailboxes description: >- Operations for connecting, listing, updating, and archiving user and shared mailboxes, including delegated OAuth sign-in. x-displayName: Mailboxes - name: media description: >- Operations for signing direct-to-storage media uploads (e.g. signature images). x-displayName: Media - name: organizations description: Operations for retrieving and managing the current organization. x-displayName: Organizations - name: outreach-workflows description: Operations for managing automated collections outreach workflows. x-displayName: Outreach Workflows - name: partners description: Operations for retrieving and managing customers. x-displayName: Partners - name: payments description: Operations for approving and managing payments. x-displayName: Payments - name: report-configs description: >- Operations for managing report configurations (frequency, recipients, schedule). x-displayName: Report Configs - name: sms-campaign-registration description: Operations for managing A2P 10DLC SMS campaign registration. x-displayName: SMS Campaign Registration - name: sms-templates description: >- Operations for defining, storing, and managing parameterized SMS message templates. x-displayName: SMS Templates - name: sms-threads description: Operations for retrieving and managing SMS conversation threads. x-displayName: SMS Threads - name: users description: Operations for retrieving and managing users. x-displayName: Users - name: users-ooo description: Operations for managing user out-of-office (OOO) status and coverage. x-displayName: Users OOO paths: /v2/mailboxes/{mailbox_id}: patch: tags: - mailboxes summary: Update a Mailbox description: |- Updates editable fields: display name, signature, reply-to, and the shared / centralized-inbox flags. Connection state (provider, grant, permission type) is set by the auth flow, not here. Permissions: the owner can update their own delegated mailbox; shared mailboxes can be updated by any org member; centralized inboxes require an org admin. operationId: PatchMailboxesMailboxId parameters: - name: mailbox_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateMailboxRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Mailbox' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: UpdateMailboxRequest: properties: name: anyOf: - type: string - type: 'null' title: '' description: Email owner's name. signature_html: anyOf: - type: string - type: 'null' title: '' description: Email signature html. is_centralized_inbox: anyOf: - type: boolean - type: 'null' title: '' description: >- Whether this sender is a centralized inbox that accepts net-new inbound emails for routing is_shared: anyOf: - type: boolean - type: 'null' title: '' description: >- Whether this email sender should be shared with the entire organization reply_to: anyOf: - type: string - type: 'null' title: '' description: This account's default reply-to type: object title: UpdateMailboxRequest description: Update editable mailbox fields. Mailbox: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' email: type: string title: '' description: The account's email. email_aliases: anyOf: - items: type: string type: array - type: 'null' title: '' name: anyOf: - type: string - type: 'null' title: '' description: Email owner's name. provider: anyOf: - type: string - type: 'null' title: '' description: Mail provider — 'microsoft', 'google', 'imap', 'sendgrid', etc. permission_type: $ref: '#/components/schemas/MailboxPermissionType' title: '' description: How this mailbox was authenticated (delegated vs application). is_shared: type: boolean title: '' description: >- Whether this email sender should be shared with the entire organization is_centralized_inbox: type: boolean title: '' description: >- Whether this sender is a centralized inbox that accepts net-new inbound emails for routing status: $ref: '#/components/schemas/MailboxStatus' title: '' description: Computed connection health. CONNECTED, EXPIRED, or DISCONNECTED. archived_at: anyOf: - type: string format: date-time - type: 'null' title: '' description: >- When the mailbox was disconnected from Stuut. Kept around for historical email attribution rather than deleted. user_id: anyOf: - type: string - type: 'null' title: '' description: Owning user. NULL for shared mailboxes. signature_html: anyOf: - type: string - type: 'null' title: '' description: Email signature html. reply_to: type: string title: '' description: This account's default reply-to object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true uses_legacy_entra_app: type: boolean title: '' description: >- True when this Microsoft mailbox's grant was minted against the legacy Entra app and must be re-authenticated to migrate onto the current app. readOnly: true type: object required: - created_at - modified_at - id - email - email_aliases - name - provider - permission_type - is_shared - is_centralized_inbox - status - archived_at - user_id - signature_html - reply_to - object - uses_legacy_entra_app title: Mailbox HTTPValidationError: $defs: ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Type type: string required: - loc - msg - type title: ValidationError type: object x-speakeasy-include: true properties: type: const: request-validation title: Type type: string detail: anyOf: - type: string - type: 'null' default: null description: Human-readable description of this specific problem. title: Detail x-speakeasy-error-message: true status: const: 422 title: Status type: integer title: description: Short human-readable summary of the problem. title: Title type: string x-speakeasy-error-message: true errors: items: $ref: '#/components/schemas/ValidationError' title: Errors type: array required: - type - status - title - errors title: APIError type: object MailboxPermissionType: type: string enum: - delegated - application title: MailboxPermissionType description: How a mailbox was authenticated. MailboxStatus: type: string enum: - connected - expired - disconnected title: MailboxStatus description: Computed connection health. ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: type: string title: Type required: - loc - msg - type title: ValidationError type: object x-speakeasy-include: true securitySchemes: HTTPBearer: type: http scheme: bearer ````