Get Started
Usage API
More information

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

Description

Updates a status of a project with the ID specified in the request.

Parameters
Name Description Type Example
id
sent in url
Project ID number 1234
status
sent in body
New project status ("Open", "Paused", or "Closed") Open, Closed, Paused Open
Example
PUT api/2.0/project/1234/status
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "status": "Open"
}
Returns

Updated project

Example Response

application/json

{
  "status": 0,
  "response": {
    "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": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "ResponsibleId": "00000000-0000-0000-0000-000000000000",
    "IsPrivate": false,
    "TaskCount": 0,
    "TaskCountTotal": 0,
    "MilestoneCount": 0,
    "DiscussionCount": 0,
    "ParticipantCount": 0,
    "TimeTrackingTotal": "TimeTrackingTotal",
    "DocumentsCount": 0,
    "IsFollow": 0,
    "Tags": [
      "Tags1",
      "Tags2"
    ],
    "UpdatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "UpdatedById": "00000000-0000-0000-0000-000000000000",
    "Created": "2020-12-22T04:11:56.5658524Z",
    "CreatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "CreatedById": "00000000-0000-0000-0000-000000000000",
    "Updated": "2020-12-22T04:11:56.5658524Z",
    "CanEdit": false,
    "CanDelete": false,
    "Security": {
      "CanCreateMilestone": false,
      "CanCreateMessage": false,
      "CanCreateTask": false,
      "CanCreateTimeSpend": false,
      "CanEditTeam": false,
      "CanReadFiles": false,
      "CanReadMilestones": false,
      "CanReadMessages": false,
      "CanReadTasks": false,
      "CanLinkContact": false,
      "CanReadContacts": false,
      "CanEdit": false,
      "CanDelete": false,
      "IsInTeam": false
    },
    "ProjectFolder": 13234
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <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>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </Responsible>
    <ResponsibleId>00000000-0000-0000-0000-000000000000</ResponsibleId>
    <IsPrivate>False</IsPrivate>
    <TaskCount>0</TaskCount>
    <TaskCountTotal>0</TaskCountTotal>
    <MilestoneCount>0</MilestoneCount>
    <DiscussionCount>0</DiscussionCount>
    <ParticipantCount>0</ParticipantCount>
    <TimeTrackingTotal>TimeTrackingTotal</TimeTrackingTotal>
    <DocumentsCount>0</DocumentsCount>
    <IsFollow>0</IsFollow>
    <Tags>Tags1</Tags>
    <Tags>Tags2</Tags>
    <UpdatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </UpdatedBy>
    <UpdatedById>00000000-0000-0000-0000-000000000000</UpdatedById>
    <Created>2020-12-22T04:11:56.5658524Z</Created>
    <CreatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreatedBy>
    <CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
    <Updated>2020-12-22T04:11:56.5658524Z</Updated>
    <CanEdit>False</CanEdit>
    <CanDelete>False</CanDelete>
    <Security>
      <CanCreateMilestone>False</CanCreateMilestone>
      <CanCreateMessage>False</CanCreateMessage>
      <CanCreateTask>False</CanCreateTask>
      <CanCreateTimeSpend>False</CanCreateTimeSpend>
      <CanEditTeam>False</CanEditTeam>
      <CanReadFiles>False</CanReadFiles>
      <CanReadMilestones>False</CanReadMilestones>
      <CanReadMessages>False</CanReadMessages>
      <CanReadTasks>False</CanReadTasks>
      <CanLinkContact>False</CanLinkContact>
      <CanReadContacts>False</CanReadContacts>
      <CanEdit>False</CanEdit>
      <CanDelete>False</CanDelete>
      <IsInTeam>False</IsInTeam>
    </Security>
    <ProjectFolder>13234</ProjectFolder>
  </response>
</result>