Get Started
Usage API
More information

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

Description

Creates an event with the parameters specified in the request.

Parameters
Name Description Type Example
contactId
sent in body
Contact ID
optional
number 1234
entityType
sent in body
Related entity type
Allowed values: opportunity or case
optional
string some text
entityId
sent in body
Related entity ID
optional
number 1234
content
sent in body
Event contents string some text
categoryId
sent in body
Event category ID number 1234
created
sent in body
Event creation date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
fileId
sent in body
List of file IDs for the current event
optional
Collection of numbers
collection
1234
notifyUserList
sent in body
List of users who will be notified about the event
optional
Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
Remark

You should obligatorily set a value for 'contactId' if 'entityId' is not set or the values for the 'entityId' and 'entityType' parameters if 'contactId' is not set.

Example
POST api/2.0/crm/history
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "contactId": 1234,
  "entityType": "some text",
  "entityId": 1234,
  "content": "some text",
  "categoryId": 1234,
  "created": "2008-04-10T06-30-00.000Z",
  "fileId": [
    1234
  ],
  "notifyUserList": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Returns

Created event

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-25T04:56:29.1185841Z",
    "content": "Agreed to meet at lunch and discuss the client commercial offer",
    "category": {
      "imagePath": "path to image",
      "title": "Lunch",
      "description": "",
      "color": "",
      "sortOrder": 10,
      "id": 30
    },
    "contact": {
      "smallFotoUrl": "url to foto",
      "displayName": "Tadjeddine Bachir",
      "isCompany": false,
      "isPrivate": true,
      "isShared": false,
      "shareType": 0,
      "currency": null,
      "canEdit": false,
      "canDelete": false,
      "id": 0
    },
    "entity": {
      "entityType": "opportunity",
      "entityId": 123445,
      "entityTitle": "Household appliances internet shop"
    },
    "canEdit": true,
    "files": [
      {
        "folderId": 12334,
        "version": 3,
        "versionGroup": 1,
        "contentLength": "12.06 KB",
        "pureContentLength": 12345,
        "fileStatus": 2,
        "viewUrl": "http:\/\/www.onlyoffice.com\/viewfile?fileid=2221",
        "fileType": 7,
        "fileExst": ".txt",
        "comment": null,
        "id": 1997721796,
        "title": "Some titile.txt",
        "access": 1,
        "shared": false,
        "rootFolderType": 2,
        "updatedBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "created": "2021-10-25T04:56:29.1185841Z",
        "createdBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "updated": "2021-10-25T04:56:29.1185841Z"
      }
    ],
    "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-25T04:56:29.1185841Z</created>
    <content>Agreed to meet at lunch and discuss the client commercial offer</content>
    <category>
      <imagePath>path to image</imagePath>
      <title>Lunch</title>
      <description></description>
      <color></color>
      <sortOrder>10</sortOrder>
      <id>30</id>
    </category>
    <contact>
      <smallFotoUrl>url to foto</smallFotoUrl>
      <displayName>Tadjeddine Bachir</displayName>
      <isCompany>false</isCompany>
      <isPrivate>true</isPrivate>
      <isShared>false</isShared>
      <shareType>0</shareType>
      <currency />
      <canEdit>false</canEdit>
      <canDelete>false</canDelete>
      <id>0</id>
    </contact>
    <entity>
      <entityType>opportunity</entityType>
      <entityId>123445</entityId>
      <entityTitle>Household appliances internet shop</entityTitle>
    </entity>
    <canEdit>true</canEdit>
    <files>
      <folderId>12334</folderId>
      <version>3</version>
      <versionGroup>1</versionGroup>
      <contentLength>12.06 KB</contentLength>
      <pureContentLength>12345</pureContentLength>
      <fileStatus>2</fileStatus>
      <viewUrl>http://www.onlyoffice.com/viewfile?fileid=2221</viewUrl>
      <fileType>7</fileType>
      <fileExst>.txt</fileExst>
      <comment />
      <id>1997721796</id>
      <title>Some titile.txt</title>
      <access>1</access>
      <shared>false</shared>
      <rootFolderType>2</rootFolderType>
      <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>2021-10-25T04:56:29.1185841Z</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>2021-10-25T04:56:29.1185841Z</updated>
    </files>
    <id>0</id>
  </response>
</result>