Update a Folder

This endpoints allow the updating of a folder.

The columns property respects the following format:

{
    "name": "Column name",
    "visible": true
}

The accepted values for the column name are:

"Name", "Licenses", "Categories", "Type", "Status", "Language", "Visibility", "Teachers", "Attendants", "Time", "Payment Model", "Availability", "Total Price", "Subscription Fee", "Remaining amount", "Payment Frequency", "Numbers of Billings", "Single Billing Amount"

Expected path parameters:

spaceId: Space Id where the folder currently resides

folderId: Folder or subfolder Id to be updated

Body properties:

id: Folder or subfolder Id to be updated

name: Folder name

parent (optional): id from its parent folder, when it isn't a root folder

columns: array of column object which contain both name and visible property

Returns:

a folder object with all their data

curl --location --request PATCH 'https://api.aladia.io/v2/spaces/66309949fb6c973f4ecaebc5/folders/66309949fb6c973f4ecaebc9' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "Crystal and Ruby courses", "spaceId": "661666becf024c47c39a2170", "parent": "661666becf024c47c39a2183", "columns": [] }'

{ "id": "661666becf024c47c39a2182", "name": "Crystal and Ruby courses", "spaceId": "661666becf024c47c39a2170", "parent": "661666becf024c47c39a2183", "items": 0, "columns": [], "courses": [] }

Request

Path Params

spaceId

string

required

Space Id where the folder resides

Example:

66309949fb6c973f4ecaebc5

folderId

string

required

Folder or subfolder Id

Example:

66309949fb6c973f4ecaebc9

Header Params

apikey

string

optional

Example:

Body Params application/json

object {0}

Examples

Request

Responses