PUT api/2.0/crm/task/{taskid} This function requires authentication

Description

Updates the selected task with the parameters (title, description, due date, etc.) specified in the request.

Parameters

Name	Description	Type	Example
taskid sent in url	Task ID	number	1234
title sent in body	New task title	string	some text
description sent in body	New task description	string	some text
deadline sent in body	New task due date	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
responsibleid sent in body	New task responsible ID	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
categoryid sent in body	New task category ID	number	1234
contactid sent in body	New contact ID	number	1234
entityType sent in body	New related entity type Allowed values: opportunity or case	string	some text
entityid sent in body	New related entity ID	number	1234
isNotify sent in body	Notifies the responsible about the task or not	Bool value	true
alertValue sent in body	New time period in minutes to remind the responsible of the task optional	number	1234

Example

PUT api/2.0/crm/task/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "title": "some text",
  "description": "some text",
  "deadline": "2008-04-10T06-30-00.000Z",
  "responsibleid": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "categoryid": 1234,
  "contactid": 1234,
  "entityType": "some text",
  "entityid": 1234,
  "isNotify": true,
  "alertValue": 1234
}

Returns

Task

Example Response

application/json

{
  "status": 0,
  "response": {
    "CreateBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "Created": "2020-12-16T03:11:54.3573531Z",
    "Contact": {
      "Email": {
        "InfoType": 1,
        "Category": 0,
        "Data": "support@onlyoffice.com",
        "CategoryName": "Home",
        "IsPrimary": true,
        "id": 1234
      },
      "id": 1234,
      "SmallFotoUrl": "url to foto",
      "MediumFotoUrl": "url to foto",
      "DisplayName": "Tadjeddine Bachir",
      "IsCompany": false,
      "AccessList": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "DisplayName": "Mike Zanyatski",
          "Title": "Manager",
          "AvatarSmall": "url to small avatar",
          "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
        }
      ],
      "IsPrivate": true,
      "IsShared": false,
      "ShareType": 0,
      "Currency": {
        "Title": "Chinese Yuan",
        "Symbol": "¥",
        "Abbreviation": "CNY",
        "CultureName": "CN",
        "IsConvertable": true,
        "IsBasic": false
      },
      "CanEdit": true,
      "CanDelete": true
    },
    "Title": "Send a commercial offer",
    "Description": "Description",
    "DeadLine": "2020-12-16T03:11:54.3573531Z",
    "AlertValue": 1,
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "IsClosed": true,
    "Category": {
      "ImagePath": "path to image",
      "id": 1234,
      "Title": "Title",
      "Description": "Description",
      "Color": "#a7fc00",
      "SortOrder": 1
    },
    "Entity": {
      "EntityType": "opportunity",
      "EntityId": 123445,
      "EntityTitle": "Household appliances internet shop"
    },
    "CanEdit": true,
    "id": 1234
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <CreateBy>
      <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>
    </CreateBy>
    <Created>2020-12-16T03:11:54.3573531Z</Created>
    <Contact>
      <Email>
        <InfoType>1</InfoType>
        <Category>0</Category>
        <Data>support@onlyoffice.com</Data>
        <CategoryName>Home</CategoryName>
        <IsPrimary>True</IsPrimary>
        <id>1234</id>
      </Email>
      <id>1234</id>
      <SmallFotoUrl>url to foto</SmallFotoUrl>
      <MediumFotoUrl>url to foto</MediumFotoUrl>
      <DisplayName>Tadjeddine Bachir</DisplayName>
      <IsCompany>False</IsCompany>
      <AccessList>
        <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>
      </AccessList>
      <IsPrivate>True</IsPrivate>
      <IsShared>False</IsShared>
      <ShareType>0</ShareType>
      <Currency>
        <Title>Chinese Yuan</Title>
        <Symbol>¥</Symbol>
        <Abbreviation>CNY</Abbreviation>
        <CultureName>CN</CultureName>
        <IsConvertable>True</IsConvertable>
        <IsBasic>False</IsBasic>
      </Currency>
      <CanEdit>True</CanEdit>
      <CanDelete>True</CanDelete>
    </Contact>
    <Title>Send a commercial offer</Title>
    <Description>Description</Description>
    <DeadLine>2020-12-16T03:11:54.3573531Z</DeadLine>
    <AlertValue>1</AlertValue>
    <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>
    <IsClosed>True</IsClosed>
    <Category>
      <ImagePath>path to image</ImagePath>
      <id>1234</id>
      <Title>Title</Title>
      <Description>Description</Description>
      <Color>#a7fc00</Color>
      <SortOrder>1</SortOrder>
    </Category>
    <Entity>
      <EntityType>opportunity</EntityType>
      <EntityId>123445</EntityId>
      <EntityTitle>Household appliances internet shop</EntityTitle>
    </Entity>
    <CanEdit>True</CanEdit>
    <id>1234</id>
  </response>
</result>