Get Started
Usage API
More information

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 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": ""
    },
    "created": "2021-10-17T22:55:39.5764638Z",
    "title": "Send a commercial offer",
    "deadLine": "2021-10-17T22:55:39.5764638Z",
    "responsible": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "category": {
      "imagePath": "path to image",
      "title": "Appointment",
      "description": "",
      "sortOrder": 2,
      "id": 30
    },
    "canEdit": true,
    "id": 0
  }
}

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></profileUrl>
    </createBy>
    <created>2021-10-17T22:55:39.5764638Z</created>
    <title>Send a commercial offer</title>
    <deadLine>2021-10-17T22:55:39.5764638Z</deadLine>
    <responsible>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </responsible>
    <category>
      <imagePath>path to image</imagePath>
      <title>Appointment</title>
      <description></description>
      <sortOrder>2</sortOrder>
      <id>30</id>
    </category>
    <canEdit>true</canEdit>
    <id>0</id>
  </response>
</result>