Get Started
Portal api methods
Help

POST api/2.0/crm/task This function requires authentication

Description

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

Parameters
Name Description Type Example
title
sent in body
Task title string some text
description
sent in body
Task description
optional
string some text
deadline
sent in body
Task due date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
responsibleId
sent in body
Task responsible ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
categoryId
sent in body
Task category ID number 1234
contactId
sent in body
Contact ID
optional
number 1234
entityType
sent in body
Related entity type
optional
string some text
entityId
sent in body
Related entity ID
optional
number 1234
isNotify
sent in body
Notify the responsible about the task
optional
Bool value true
alertValue
sent in body
Time period in minutes for reminder to the responsible about the task
optional
number 1234
Example
POST api/2.0/crm/task
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": "2019-10-15T09:54:27.4223546Z",
    "title": "Send a commercial offer",
    "deadLine": "2019-10-15T09:54:27.4223546Z",
    "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>2019-10-15T09:54:27.4223546Z</created>
    <title>Send a commercial offer</title>
    <deadLine>2019-10-15T09:54:27.4223546Z</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>