Zapmail
v1
  • latest
  • v1
v1
  • latest
  • v1
Sign In
v1
  • latest
  • v1
Root
Root
  1. mailbox
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • workspaces
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
  • billing
    • Add Billing Details
      POST
  • mailbox
    • Retrieve All Mailboxes
      GET
    • Get Mailbox Details by ID
      GET
    • Assign New Mailboxes to Domains
      POST
    • Update mailbox
      PUT
    • Remove mailboxes on next renewal
      PUT
  • payments & wallet
    • Add balance to wallet
      POST
    • Get wallet balance
      GET
    • Enable auto recharge
      POST
  • export
    • Export mailboxes
      POST
    • Add third party account details
      POST
    • Update third party account details
      POST
  • subscriptions
    • Get all subscriptions
      GET
    • Cancel subscription
      POST
    • Upgrade existing subscription
      POST
  • domains
    • Retrieve All Domains
      GET
    • List Assignable Domains
      GET
    • Add DMARC record
      POST
    • Add Domain forwarding
      POST
    • Get Name servers to connect domain
      POST
    • Verify Name Server Propagation
      POST
    • Connect Domain with Zapmail
      POST
    • Enable email forwarding
      POST
    • Remove email forwarding
      DELETE
    • Enable catch all emails
      POST
    • Remove catch all emails
      DELETE
    • Check DNS records
      POST
    • Remove unused domains
      DELETE
    • Get available domains for registration
      POST
    • Get domains purchase payment link
      POST
  1. mailbox

Update mailbox

PUT
/v1/mailbox/update

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.

Request

Header Params

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.zapmail.ai/api/v1/mailbox/update' \
--header 'x-auth-zapmail: '
Response Response Example
{
    "status": 200,
    "message": "User details changes are in progress",
    "data": [
        {
            "mailboxId": "a9a0feda-ca3a-435c-a357-385d36e92f5a",
            "profileUrl": "",
            "failureDetails": []
        }
    ]
}
Modified at 2025-01-30 13:13:50
Previous
Assign New Mailboxes to Domains
Next
Remove mailboxes on next renewal
Built with