Check Workspace Existence

POST

/domains/has-workspace

Checks whether a Google or Microsoft workspace already exists for a domain.

Use this before registering a domain to detect conflicts with existing workspaces. Supports both single-domain and bulk checks.

Single domain

{ "domainName": "acmecorp.com", "serviceProvider": "GOOGLE" }

Returns data: null when no workspace exists (safe to register).

Bulk check

{ "domains": [{ "domainName": "acmecorp.com", "serviceProvider": "GOOGLE" }, { "domainName": "example.com" }] }

Returns an array where each item has success: true (no workspace) or success: false with an error message.

Note: Each domain check has a 15-second timeout. Timed-out domains are reported as success: false.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Workspace not exists (single mode).

Bodyapplication/json

🟢200Success

🟠400Bad Request

🟠409Conflict

🟠422Unprocessable Entity

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/domains/has-workspace' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "domainName": "acmecorp.com",
    "serviceProvider": "GOOGLE",
    "domains": [
        {
            "domainName": "acmecorp.com",
            "serviceProvider": "GOOGLE"
        }
    ]
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Workspace not exists",
    "data": null
}

Modified at 2026-08-10 11:13:04

Check Single Domain Availability

Set Domain Forwarding

Check Workspace Existence

Single domain#

Bulk check#

Request

Responses

Single domain

Bulk check