Docmost Octri Preview
POST/workspace/create

Create a cloud workspace

Creates a new workspace on the cloud platform with an administrator account. Provide the workspace name and the administrator's email and password to set up the workspace.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields

Cloud workspace details and credentials for its administrator account.

emailstringrequired
Email for the admin account.
namestringrequired
Workspace name.
passwordstringrequired
Password for the admin account.

2 status codes
200Returns the created workspace in the response payload.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when a required field is missing or a value fails validation.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when a required field is missing or a value fails validation. name, email, and password are required; email must use email format, name must be 1 to 50 characters, and password must be 8 to 70 characters.