Update Mailbox

PUT

/v1/mailboxes/{id}

Update mailbox details such as full name or status.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/jsonRequired

Example

{
    "fullName": "Mary Jane",
    "status": "PENDING"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/v1/mailboxes/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "fullName": "Mary Jane",
    "status": "PENDING"
}'

Responses

🟢200

application/json

Mailbox updated successfully

Bodyapplication/json

Example

{
    "id": "cmg9l78m8000bla04a6onx0ih",
    "username": "Mary",
    "fullName": "Mary",
    "status": "PENDING",
    "createdAt": "2025-10-02T15:45:32.768Z"
}

🟠400

🟠401

🟠404

Get Mailbox Details

Remove Mailbox (Next Renewal)