Create an HTML file in the "My documents" section

POST /api/2.0/files/@my/html

Request

Creates an HTML (.html) file in the "My documents" section with the title and contents specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

titlestringrequired
contentstring
createNewIfExistboolean

Examples

POST /api/2.0/files/@my/html HTTP/1.1
Accept: application/json
Content-Length: 104
Content-Type: application/json
Host: example.com

{
  "title": "markets_solution_oriented_content",
  "content": "some text",
  "createNewIfExist": true
}
curl --request POST \
  --url https://example.com/api/2.0/files/@my/html \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "markets_solution_oriented_content",
  "content": "some text",
  "createNewIfExist": true
}'

Responses

200

New file information

titlestring
accessone of
.enum of string

[None - None, ReadWrite - Read and write, Read - Read, Restrict - Restrict, Varies - Varies, Review - Review, Comment - Comment, FillForms - Fill forms, CustomFilter - Custom filter, RoomAdmin - Room admin, Editing - Editing, PowerUser - Power user]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomAdmin, Editing, PowerUser.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room admin, 10 - Editing, 11 - Power user]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

sharedboolean
createdobject
utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span
createdByobject
idstringformat: uuid
displayNamestring
titlestring
avatarstring
avatarOriginalstring
avatarMaxstring
avatarMediumstring
avatarSmallstring
profileUrlstring
hasAvatarboolean
isAnonimboolean
updatedobject
utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span
autoDeleteobject
utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span
rootFolderTypeone of
.enum of string

[DEFAULT - Default, COMMON - Coomon, BUNCH - Bunch, TRASH - Trash, USER - User, SHARE - Share, Projects - Projects, Favorites - Favourites, Recent - Recent, Templates - Templates, Privacy - Privacy, VirtualRooms - Virtual rooms, FillingFormsRoom - Filling forms room, EditingRoom - Editing room, CustomRoom - Custom room, Archive - Archive, ThirdpartyBackup - Thirdparty backup, PublicRoom - Public room, ReadyFormFolder - Ready form folder, InProcessFormFolder - In process form folder, FormFillingFolderDone - Form filling folder done, FormFillingFolderInProgress - Form filling folder in progress]

Can be one of: DEFAULT, COMMON, BUNCH, TRASH, USER, SHARE, Projects, Favorites, Recent, Templates, Privacy, VirtualRooms, FillingFormsRoom, EditingRoom, CustomRoom, Archive, ThirdpartyBackup, PublicRoom, ReadyFormFolder, InProcessFormFolder, FormFillingFolderDone, FormFillingFolderInProgress.

.enum of integer

[0 - Default, 1 - Coomon, 2 - Bunch, 3 - Trash, 5 - User, 6 - Share, 8 - Projects, 10 - Favourites, 11 - Recent, 12 - Templates, 13 - Privacy, 14 - Virtual rooms, 15 - Filling forms room, 16 - Editing room, 19 - Custom room, 20 - Archive, 21 - Thirdparty backup, 22 - Public room, 25 - Ready form folder, 26 - In process form folder, 27 - Form filling folder done, 28 - Form filling folder in progress]

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28.

parentRoomTypeone of
.enum of string

[DEFAULT - Default, COMMON - Coomon, BUNCH - Bunch, TRASH - Trash, USER - User, SHARE - Share, Projects - Projects, Favorites - Favourites, Recent - Recent, Templates - Templates, Privacy - Privacy, VirtualRooms - Virtual rooms, FillingFormsRoom - Filling forms room, EditingRoom - Editing room, CustomRoom - Custom room, Archive - Archive, ThirdpartyBackup - Thirdparty backup, PublicRoom - Public room, ReadyFormFolder - Ready form folder, InProcessFormFolder - In process form folder, FormFillingFolderDone - Form filling folder done, FormFillingFolderInProgress - Form filling folder in progress]

Can be one of: DEFAULT, COMMON, BUNCH, TRASH, USER, SHARE, Projects, Favorites, Recent, Templates, Privacy, VirtualRooms, FillingFormsRoom, EditingRoom, CustomRoom, Archive, ThirdpartyBackup, PublicRoom, ReadyFormFolder, InProcessFormFolder, FormFillingFolderDone, FormFillingFolderInProgress.

.enum of integer

[0 - Default, 1 - Coomon, 2 - Bunch, 3 - Trash, 5 - User, 6 - Share, 8 - Projects, 10 - Favourites, 11 - Recent, 12 - Templates, 13 - Privacy, 14 - Virtual rooms, 15 - Filling forms room, 16 - Editing room, 19 - Custom room, 20 - Archive, 21 - Thirdparty backup, 22 - Public room, 25 - Ready form folder, 26 - In process form folder, 27 - Form filling folder done, 28 - Form filling folder in progress]

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28.

updatedByobject
idstringformat: uuid
displayNamestring
titlestring
avatarstring
avatarOriginalstring
avatarMaxstring
avatarMediumstring
avatarSmallstring
profileUrlstring
hasAvatarboolean
isAnonimboolean
providerItemboolean
providerKeystring
providerIdintegerformat: int32
orderstring
idintegerformat: int32
rootFolderIdintegerformat: int32
originIdintegerformat: int32
originRoomIdintegerformat: int32
originTitlestring
originRoomTitlestring
canShareboolean
securityobject
Readboolean
Commentboolean
FillFormsboolean
Reviewboolean
Createboolean
Editboolean
Deleteboolean
CustomFilterboolean
EditRoomboolean
Renameboolean
ReadHistoryboolean
Lockboolean
EditHistoryboolean
CopyToboolean
Copyboolean
MoveToboolean
Moveboolean
Pinboolean
Muteboolean
EditAccessboolean
Duplicateboolean
SubmitToFormGalleryboolean
Downloadboolean
Convertboolean
CopySharedLinkboolean
ReadLinksboolean
Reconnectboolean
CreateRoomFromboolean
EditFormboolean
CopyLinkboolean
Embedboolean
folderIdintegerformat: int32
versionintegerformat: int32
versionGroupintegerformat: int32
contentLengthstring
pureContentLengthintegerformat: int64
fileStatusone of
.enum of string

[None - None, IsEditing - Is editing, IsNew - Is new, IsConverting - Is converting, IsOriginal - Is original, IsEditingAlone - Is editing alone, IsFavorite - Is favorite, IsTemplate - Is template, IsFillFormDraft - Is fill form draft]

Can be one of: None, IsEditing, IsNew, IsConverting, IsOriginal, IsEditingAlone, IsFavorite, IsTemplate, IsFillFormDraft.

.enum of integer

[0 - None, 1 - Is editing, 2 - Is new, 4 - Is converting, 8 - Is original, 16 - Is editing alone, 32 - Is favorite, 64 - Is template, 128 - Is fill form draft]

Can be one of: 0, 1, 2, 4, 8, 16, 32, 64, 128.

muteboolean
viewUrlstringformat: uri
webUrlstringformat: uri
fileTypeone of
.enum of string

[Unknown - Unknown, Archive - Archive, Video - Video, Audio - Audio, Image - Image, Spreadsheet - Spreadsheet, Presentation - Presentation, Document - Document, Pdf - Pdf]

Can be one of: Unknown, Archive, Video, Audio, Image, Spreadsheet, Presentation, Document, Pdf.

.enum of integer

[0 - Unknown, 1 - Archive, 2 - Video, 3 - Audio, 4 - Image, 5 - Spreadsheet, 6 - Presentation, 7 - Document, 10 - Pdf]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 10.

fileExststring
commentstring
encryptedboolean
thumbnailUrlstringformat: uri
thumbnailStatusone of
.enum of string

[Waiting - Waiting, Created - Created, Error - Error, NotRequired - Not required, Creating - Creating]

Can be one of: Waiting, Created, Error, NotRequired, Creating.

.enum of integer

[0 - Waiting, 1 - Created, 2 - Error, 3 - Not required, 4 - Creating]

Can be one of: 0, 1, 2, 3, 4.

lockedboolean
lockedBystring
denyDownloadboolean
hasDraftboolean
isFormboolean
startFillingboolean
inProcessFolderIdintegerformat: int32
inProcessFolderTitlestring
draftLocationobject
folderIdintegerformat: int32
folderTitlestring
fileIdintegerformat: int32
fileTitlestring
denySharingboolean
viewAccessibilityobject
ImageViewboolean
MediaViewboolean
WebViewboolean
WebEditboolean
WebReviewboolean
WebCustomFilterEditingboolean
WebRestrictedEditingboolean
WebCommentboolean
CoAuhtoringboolean
CanConvertboolean
MustConvertboolean
availableExternalRightsobject
requestTokenstring
lastOpenedobject
utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span
fileEntryTypeenum of integerformat: int32

Can be one of: 1, 2.

401

Unauthorized

403

Forbidden

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).