Creating a new workspace
To create a new workspace you can use the /workspaces endpoint.
Only 2 fields are required:
- projectName: The name of the workspace to be created.
- status: The status of the workspace to be created. This should be ‘A’ for ‘Active’ when creating new workspaces.
Note: There is no limit to the number of workspaces each API user can create.
High-level request elements
|
projectName |
String Specifies the name of the workspace to be created. |
|
projectNumber |
String Specifies the reference ID for the workspace from the user side. Generally not used.
Note: This is not the actual workspace ID. It’s just a custom reference ID given by you for your own purposes. |
|
status |
String Specifies the status of the workspace being created. The status can be either:
|
|
billingcostcentre |
String Allows the user to set a billing cost centre for the workspace.
Note: This is only applicable to customers with the Billing Cost Centre module enabled. |
{{codeStart}}
HTTP 1.1 POST https://api.<region>.whispir.com/workspaces?apikey=[your_api_key]
Authorization: Basic asdf98nf89asdvasd2r398h8sdf
x-api-key: your_api_key
Content-Type: application/vnd.whispir.workspace-v1+json
{
"projectName": "A Space Odessey",
"projectNumber": "2001",
"status": "A",
"billingcostcentre": "Hollywood"
}
{{codeEnd}}