Assign New Mailboxes to Domains

POST

/v2/mailboxes

Add Mailboxes to a Domain

This endpoint allows you to add mailboxes to a specific domain.

Endpoint

Request Body

The request body consists of a key-value structure where the key represents domain ID on which mailboxes are to be assigned, and the value is an array of mailbox objects.

Name	Type	Description
`firstName`	`string`	The first name of the mailbox owner.
`lastName`	`string`	The last name of the mailbox owner.
`mailboxUsername`	`string`	The username for the mailbox.
`domainName`	`string`	The domain to which the mailbox belongs.

Example Request

{
    "64e71b99-bc07-4b5d-90b6-6abc0120c08c": [
        {
            "firstName": "Jaspreet",
            "lastName": "Singh",
            "mailboxUsername": "jaspreet",
            "domainName": "azhaz.com"
        }
    ]
}

Request

Header Params

x-auth-zapmail

string

required

Example:

Body Params application/json

object {0}

Example

{
  "64e71b99-bc07-4b5d-90b6-6abc0120c08c": [
    {
      "firstName": "Jaspreet",
      "lastName": "Singh",
      "mailboxUsername": "jaspreet",
      "domainName": "azhaz.com"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zapmail.ai/api/v2/mailboxes' \
--header 'x-auth-zapmail: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "64e71b99-bc07-4b5d-90b6-6abc0120c08c": [
        {
            "firstName": "Jaspreet",
            "lastName": "Singh",
            "mailboxUsername": "jaspreet",
            "domainName": "azhaz.com"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
  "status": 200,
  "message": "Mailboxes will be assigned shortly",
  "data": null
}

Get Mailbox Details by ID

Update mailbox

Assign New Mailboxes to Domains

Add Mailboxes to a Domain#

Endpoint#

Request Body#