Get Started
Portal api methods
Help

PUT api/2.0/project/{id} This function requires authentication

Description

Updates the existing project information using all the parameters (project ID, title, description, responsible ID, etc) specified in the request

Parameters
Name Description Type Example
id
sent in url
Project ID number 1234
title
sent in body
Title string some text
description
sent in body
Description string some text
responsibleId
sent in body
Responsible ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
tags
sent in body
Tags string some text
participants
sent in body
participants Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
private
sent in body
Is project private
optional
Bool value true
status
sent in body
Status. One of (Open|Closed)
optional
project status Open = 0, Closed = 1
notify
sent in body
Notify project manager Bool value true
Example
PUT api/2.0/project/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "title": "some text",
  "description": "some text",
  "responsibleId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "tags": "some text",
  "participants": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "private": null,
  "status": null,
  "notify": true
}
Returns

Updated project

Example Response

application/json

{
  "status": 0,
  "response": {
    "canEdit": false,
    "canDelete": false,
    "security": null,
    "projectFolder": 13234,
    "id": 10,
    "title": "Sample Title",
    "description": "Sample description",
    "status": 0,
    "responsible": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "isPrivate": false,
    "taskCount": 0,
    "taskCountTotal": 0,
    "milestoneCount": 0,
    "discussionCount": 0,
    "participantCount": 0,
    "timeTrackingTotal": null,
    "documentsCount": 0,
    "isFollow": false,
    "updatedBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "created": "2019-08-17T20:39:00.2214141Z",
    "createdBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "updated": "2019-08-17T20:39:00.2214141Z"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <canEdit>false</canEdit>
    <canDelete>false</canDelete>
    <security />
    <projectFolder>13234</projectFolder>
    <id>10</id>
    <title>Sample Title</title>
    <description>Sample description</description>
    <status>0</status>
    <responsible>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </responsible>
    <isPrivate>false</isPrivate>
    <taskCount>0</taskCount>
    <taskCountTotal>0</taskCountTotal>
    <milestoneCount>0</milestoneCount>
    <discussionCount>0</discussionCount>
    <participantCount>0</participantCount>
    <timeTrackingTotal />
    <documentsCount>0</documentsCount>
    <isFollow>false</isFollow>
    <updatedBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </updatedBy>
    <created>2019-08-17T20:39:00.2214141Z</created>
    <createdBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createdBy>
    <updated>2019-08-17T20:39:00.2214141Z</updated>
  </response>
</result>