Update mailbox

This endpoint allows updating mailbox details, including:

First Name

Last Name

Username

Profile Picture

Use this endpoint to make modifications to mailbox information as needed.

mailboxData

Type: array

Description: An array of mailboxes to be updated. Each mailbox object should include:

mailboxId (string): The unique ID of the mailbox.

firstName (string): The updated first name.

lastName (string): The updated last name.

username (string): The updated username.

profilePicture (string): The URL or path to the new profile picture. Leave empty to keep the current picture.

removeProfilePicture (boolean): Set to true if you want to remove the current profile picture; otherwise, set to false.

Validation Rules

Payload Structure

mailboxData must be a non-empty array.

Each mailbox object must include all required fields.

username

Must follow valid email username rules:

Cannot start or end with ., _, or -

Cannot contain consecutive ., _, or -

Must be alphanumeric or include valid symbols ., _, -

profilePicture

If profilePicture is provided, it must be a valid URL or path string.

If removeProfilePicture is true, profilePicture can be ignored.

mailboxId (Optional)

If provided, must match one of the mailboxIds in mailboxData.

NOTE: At least one of these mailboxId, domainId, userId is required

Request

Header Params

Body Params application/json

Example

{
  "mailboxData": [
    {
      "userId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "firstName": "Alice",
      "lastName": "Johnson",
      "username": "alice.johnson",
      "removeProfilePicture": true
    },
    {
      "mailboxId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "firstName": "Bob",
      "lastName": "Wilson"
    },
    {
      "domainId": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "firstName": "Charlie",
      "lastName": "Brown",
      "profilePicture": "https://cdn.example.com/charlie.jpg"
    }
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body