Zapmail
v1
  • latest
  • v1
  1. workspaces
Zapmail
v1
  • latest
  • v1
  • 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. workspaces

Create new workspace

POST
/v1/workspace/create

Create a New Workspace#

This endpoint allows you to create a new workspace.

Endpoint#

Request Body#

NameTypeDescription
namestringThe name of the new workspace.

Example Request#

{
  "name": "New Workspace"
}

Request

Header Params
x-auth-zapmail
string 
required
Example:
{{x-auth-zapmail}}
Body Params application/json
object {0}
Example
{
  "name": "New Workspace"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.zapmail.ai/api/v1/workspace/create' \
--header 'x-auth-zapmail: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Workspace"
}'

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
  }
}
Previous
Retrieve all workspaces
Next
Update workspace
Built with