Create new workspace

POST

/v2/workspaces

Use this endpoint to create a new workspace for your Zapmail account. Each workspace can hold domains, mailboxes, and user-specific settings. Workspace names must be unique per account.

Request

Header Params

Body Params application/json

Example

{
    "name": "New Workspace",
    "billingDetails": {
        "company": "Tech Solutions Ltd.",
        "firstName": "John",
        "lastName": "Doe",
        "addressLineOne": "1234 Elm Street",
        "addressLineTwo": "Apt 567",
        "addressLineThree": null,
        "city": "San Francisco",
        "state": "California",
        "country": "USA",
        "postalCode": "94107",
        "phoneCc": "+1",
        "phone": "4151234567",
        "languagePreference": "en"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zapmail.ai/api/v2/workspaces' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Workspace",
    "billingDetails": {
        "company": "Tech Solutions Ltd.",
        "firstName": "John",
        "lastName": "Doe",
        "addressLineOne": "1234 Elm Street",
        "addressLineTwo": "Apt 567",
        "addressLineThree": null,
        "city": "San Francisco",
        "state": "California",
        "country": "USA",
        "postalCode": "94107",
        "phoneCc": "+1",
        "phone": "4151234567",
        "languagePreference": "en"
    }
}'

Responses

🟢200Success

application/json

Body

Examples

Success409 - Workspace already exists

{
    "status": 200,
    "message": "Workspace created successfully",
    "data": {
        "id": "f69cde69-ab43-4168-b78b-77a50a02b8dd",
        "name": "New Workspace",
        "userId": "fbf34af0-be3b-4add-bd97-462e2471f65d",
        "updatedAt": "2024-08-09T06:10:04.855Z",
        "createdAt": "2024-08-09T06:10:04.855Z",
        "deletedAt": null
    }
}

🟠409Conflict

Modified at 2025-10-14 09:20:32

Retrieve all workspaces

Update workspace