Create a Space - Aladia API

Create a new space that will belong to the user or organization sending this request.

The accepted values for the mode value are:

"teaching", "learning", "organization-purchases"

curl --location --request POST 'https://api.aladia.io/v2/spaces' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "ExpressJS courses", "color": "#2E90FA", "mode": "teaching", "image": { "fileId": "a4eceacc-8894-4a45-8c81-a08825d63faf", "metadata": { "size": 14234, "mimetype": "image/png", "name": "hello.png" } } }'

{ "id": "667eb5c2f3f8f2061ec9fa37", "owner": { "id": "667987a0bed354f438d8747e", "type": "profile" }, "createdBy": "667987a0bed354f438d8747e", "name": "Hello courses", "type": "", "mode": "", "color": "#2E90FA", "numberOf": { "supervisors": 0, "coordinators": 0, "members": 0, "courses": 0, "folders": 0 }, "createdAt": "2024-06-28T13:07:11.921Z", "updatedAt": "2024-06-28T13:07:11.921Z", "updatedBy": "667987a0bed354f438d8747e", "rootFolder": { "id": "667eb5c3f3f8f2061ec9fa3b", "name": "Root folder for Hello courses'", "parent": null, "columns": [], "subFolders": [], "courses": [] }, "icon": "space-ic-flav", "image": null, "members": null }

Request

Header Params

apikey

string

optional

Example:

Body Params application/json

name

string

required

Space name

type

string | null

optional

Space type

color

string | null

optional

Color code [hex]

icon

string | null

optional

Space icon

image

object

optional

Image of the space

fileId

string

required

the file id when it's uploaded

metadata

object

required

metadata of the file

autoGenerated

boolean

optional

This will make every field opitional

Examples

Responses

🟢201Created

application/json

Body

string <uuid>

optional

Example:

12345abcd

owner

object (Owner.model)

optional

string

required

Example:

12345abcd

type

string

required

name

string

optional

name

color

string

optional

numberOf

object (NumberOf.model)

optional

supervisors

number

optional

coordinators

number

optional

members

number

optional

owners

number

optional

courses

number

optional

folders

number

optional

rootFolder

object (RootFolder.rto)

required

name + surname

string <uuid>

required

Example:

12345abcd

name

string

required

name + surname

parent

string

optional

columns

array[object (Column.model) {2}]

optional

courses

array[object (Space-course.rto) {6}]

required

subFolders

array [anyOf]

required

icon

string | null

optional

type

string | null

optional

mode

string | null

optional

members

array[object (member.rto) {10}]

optional

string

optional

The start date for the usage range [ISODate]

fullName

string

optional

The end date for the usage range [ISODate]

picture

string

optional

Usage results as array of measurements

role

string

optional

group

string

optional

online

boolean

optional

invited

boolean

optional

invitedAt

string

optional

lastActivity

string

optional

invitationStatus

string

optional

createdAt

string

optional

updatedAt

string

optional

createdBy

string | null

optional

updatedBy

string | null

optional

isOwner

boolean

optional

image

object | null

optional

metadata

object

optional

url

string

optional

🟠401Unauthorized

🟠422Parameter Error

🟠403Forbidden