Create new workspace

POST

/v2/workspaces

Create a New Workspace

This endpoint allows you to create a new workspace.

Endpoint

Request Body

Name	Type	Description
`name`	`string`	The name of the new workspace.
`billigDetails`	`object`	Billing details of the user for current workspace.

Request

Header Params

x-auth-zapmail

string

required

Example:

Body Params application/json

name

string

required

billingDetails

object

required

company

string

required

firstName

string

required

lastName

string

required

addressLineOne

string

required

addressLineTwo

string

optional

addressLineThree

string

optional

city

string

required

state

string

required

country

string

required

postalCode

string

required

phoneCc

string

required

phone

string

required

languagePreference

string

required

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 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 '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

object {0}

Example

{
    "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
    }
}

Modified at 2025-03-18 12:36:24

Retrieve all workspaces

Update workspace

Create new workspace

Create a New Workspace#

Endpoint#

Request Body#

Request

Request samples

Responses

Create a New Workspace

Endpoint

Request Body