Skip to main content
POST
/
v2
/
workspace
Create Workspace
curl --request POST \
  --url https://api.sonderplan.com/v2/workspace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Sydney Studio",
  "id": 9458,
  "description": "Sydney Office, Level 2",
  "resources": [
    {
      "name": "Edit Suite 1",
      "description": "Sydney Office, Level 2",
      "type_id": 1,
      "type_person_id": 0,
      "parent_id": 2908,
      "parent_name": "Cameras",
      "icon": [
        {
          "name": "Avid_Icon",
          "size": 174285,
          "alias": "7e73ab25155974c230d09494548201b9f5056ef",
          "extension": "png",
          "mime_type": "image/png"
        }
      ]
    }
  ],
  "access": [
    {
      "id": 4,
      "acl": "RW",
      "name": "Administrators",
      "type": "group"
    }
  ],
  "feed": "<string>",
  "working_week": 3,
  "country_region": "AU-NSW",
  "show_public_holiday": true
}
'
{
  "success": {
    "id": 1
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Workspace object that needs to be added

Workspace model

​
name
string
required

Name of the workspace

Example:

"Sydney Studio"

​
id
integer

Automatically generated unique workspace id

Example:

9458

​
description
string

Additional info about the workspace

Example:

"Sydney Office, Level 2"

​
resources
Resource Summary Model · object[]

The resources that have been assigned to the workspace

​
access
User Group Access Summary · object[]

The users and groups who have been given access to the workspace

​
feed
string

iCalendar subscription feed URL (if enabled)

​
working_week
integer

Identifer of one of the following predefined working week templates. 0 = Monday -> Friday (Saturday / Sunday), 1 = Monday -> Saturday (Sunday), 2 = Saturday -> Thursday (Friday), 3 = Sunday -> Thursday (Friday / Saturday)

Example:

3

​
country_region
string

Identifier of the country / state that public holidays should be loaded for. Only required if show_public_holiday = true

Example:

"AU-NSW"

​
show_public_holiday
boolean

Should public holidays be loaded on the workspace

Example:

true

Response

Successful Operation

​
success
object