Skip to main content
POST
Create Workspace
Use this API to programmatically create a new Velt workspace. Protected by IP-based rate limiting and disposable email domain blocking.
This is a public endpoint — no authentication headers are required.

Endpoint

POST https://api.velt.dev/v2/workspace/create

Body

Params

data
object
required

Example Request

Example Response

Success Response

apiKeyList is a keyed object (not an array). Each key is the API key ID. To extract the first API key, use Object.keys(result.data.apiKeyList)[0] in JavaScript or iterate over the object keys.

Failure Response

If email domain is disposable
If rate limit exceeded

Next Steps

After creating a workspace, use the response values for subsequent API calls:
  • Workspace-level endpoints (e.g., Get Workspace, Create API Key): pass result.data.id as the x-velt-workspace-id header and result.data.authToken as the x-velt-auth-token header.
  • API-key-level endpoints (e.g., Add Domains, Update Email Config): extract the API key ID from Object.keys(result.data.apiKeyList)[0], then retrieve its auth token via Get Auth Tokens. Pass these as x-velt-api-key and x-velt-auth-token.