Update Mailbox Details API

This endpoint allows you to update the following details for mailboxes:

First Name

Last Name

Username

Profile Picture

Use this endpoint to make changes to the mailbox information as needed.

Body

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.

mailboxId (Actual mailbox id)

Type: string (Optional)

Description: The ID of a specific mailbox if you want to upload an image for that mailbox only. If you include this, it should match one of the IDs in mailboxData.

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "User details changes are in progress",
    "data": [
        {
            "mailboxId": "a9a0feda-ca3a-435c-a357-385d36e92f5a",
            "profileUrl": "",
            "failureDetails": []
        }
    ]
}

Update mailbox

Update Mailbox Details API

Body

mailboxData

mailboxId (Actual mailbox id)

Request

Request Code Samples

Responses

Update mailbox

Update Mailbox Details API#

Body#

mailboxData#

mailboxId (Actual mailbox id)#

Request

Request Code Samples

Responses

Update Mailbox Details API

Body

mailboxData

mailboxId (Actual mailbox id)