Update the project settings

PUT /api/2.0/project/settings

Request

Updates the project settings with the parameters specified in the request.

Authorization

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

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

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

everebodyCanCreatearray of boolean

Specifies if all the portal users can create projects or not

hideEntitiesInPausedProjectsarray of boolean

Specifies if the entities will be hidden in the paused projects or not

startModulearray of integer

Module type: Projects, Tasks, Discussions, TimeTracking

folderIdobject

Folder ID

Examples

PUT /api/2.0/project/settings HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request PUT \
  --url https://example.com/api/2.0/project/settings \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Updated project settings

EverebodyCanCreateboolean
HideEntitiesInPausedProjectsboolean
StartModuleTypeenum of integerformat: int32

[0 - Projects, 1 - Tasks, 2 - Discussions, 3 - TimeTracking]

Can be one of: Projects, Tasks, Discussions, TimeTracking.

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, 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).