folder

Create a new folder

Creates a new directory for organizing content. Returns the folderId of the new folder.

post/folder

Request

  • Base URL
    https://public.stonly.com/api/v3
  • Auth
    HTTP basic

Query parameters

teamIdinteger

ID of the team to manage. Optional if the API key is associated with a single team.

Request body

parentFolderIdnumber

ID of the parent folder. Omit to create at the root level.

namestring

Name of the new folder.

descriptionstring

Optional description.

publicAccess0 | 1

1 = Public, 0 = Private/Restricted.

language'am' | 'ar' | 'bg' | 'bn' | 'bs' | 'ca' | 'cn' | 'cs' | 'cy' | 'da' | 'de' | 'de-AT' | 'de-CH' | 'el' | 'en' | 'en-GB' | 'en-US' | 'es' | 'es-CL' | 'es-EC' | 'et' | 'eu' | 'fa' | 'fi' | 'fr' | 'fr-BE' | 'fr-CA' | 'ga' | 'gd' | 'he' | 'hi' | 'hr' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kn' | 'ko' | 'lt' | 'lv' | 'mi' | 'mk' | 'nb' | 'nl' | 'nl-BE' | 'nn' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'sl' | 'sq' | 'sr' | 'sv' | 'sw' | 'th' | 'tl' | 'tr' | 'uk' | 'ur' | 'vi' | 'zh' | 'zh-Hant'

The ISO 639-1 language code (with some regional variants). Supported values map as follows:

|---|---|---|---|---|---| | am | Amharic | ar | Arabic | bg | Bulgarian | | bn | Bengali | bs | Bosnian | ca | Catalan | | cn | Montenegrin | cs | Czech | cy | Welsh | | da | Danish | de | German | de-AT | German (Austria) | | de-CH | German (Switzerland) | el | Greek | en | English | | en-GB | English (UK) | en-US | English (US) | es | Spanish | | es-CL | Spanish (Chile) | es-EC | Spanish (Ecuador) | et | Estonian | | eu | Basque | fa | Persian | fi | Finnish | | fr | French | fr-BE | French (Belgium) | fr-CA | French (Canada) | | ga | Irish | gd | Scots Gaelic | he | Hebrew | | hi | Hindi | hr | Croatian | hu | Hungarian | | hy | Armenian | id | Indonesian | is | Icelandic | | it | Italian | ja | Japanese | ka | Georgian | | kn | Kannada | ko | Korean | lt | Lithuanian | | lv | Latvian | mi | Maori | mk | Macedonian | | nb | Norwegian Bokmål | nl | Dutch | nl-BE | Flemish | | nn | Norwegian Nynorsk | no | Norwegian | pl | Polish | | pt | Portuguese | pt-BR | Portuguese (Brazil) | ro | Romanian | | ru | Russian | sk | Slovak | sl | Slovenian | | sq | Albanian | sr | Serbian | sv | Swedish | | sw | Swahili | th | Thai | tl | Tagalog (Filipino) | | tr | Turkish | uk | Ukrainian | ur | Urdu | | vi | Vietnamese | zh | Chinese (Simplified) | zh-Hant | Chinese (Traditional) |

Example request

{
  "parentFolderId": 1,
  "name": "Example folder name",
  "description": "Human readable folder description"
}

Response

Folder successfully created.

folderIdSchema (unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.