POST api/Histories

Create a new History

Request Information

URI Parameters

None.

Body Parameters

History
NameDescriptionTypeAdditional information
Id

SQL Column Name: [HISTORYID]

globally unique identifier

None.

Regarding

SQL Column Name: [REGARDING]

string

None.

Duration

SQL Column Name: [DURATION]

string

None.

OutlookID

string

None.

HistoryTypeID

SQL Column Name: [HISTORYTYPEID]

integer

None.

HistoryType

HistoryType

None.

Attachment

Attachment

None.

IsPrivate

boolean

None.

ManageUserId

globally unique identifier

None.

EditDate

SQL Column Name: [EDIT_DATE]

date

None.

CreateDate

SQL Column Name: [CREATE_DATE]

date

None.

StartTime

SQL Column Name: [START_DATE_TIME]

date

None.

EndTime

SQL Column Name: [END_DATE_TIME]

date

None.

Details

SQL Column Name: [DETAILS]

string

None.

LinkedEntities

LinkedEntities

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "b4b33921-6210-4772-874b-9230fd829b71",
  "Regarding": "sample string 2",
  "Duration": "sample string 3",
  "OutlookID": "sample string 4",
  "HistoryTypeID": 5,
  "HistoryType": {
    "Name": "sample string 1",
    "HistoryTypeId": 2,
    "Description": "sample string 3",
    "ActivityTypeID": "sample string 4",
    "ActivityTypeName": "sample string 5",
    "IsActive": true,
    "IsCustom": true,
    "IsDefault": true,
    "IsUserRecordable": true
  },
  "Attachment": {
    "DisplayName": "sample string 1",
    "FileSize": 2.1,
    "LastModified": "2024-12-05T02:34:11Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "0575c3a7-7820-4d54-9542-3a0a4c3273ea",
  "EditDate": "2024-12-05T02:34:11Z",
  "CreateDate": "2024-12-05T02:34:11Z",
  "StartTime": "2024-12-05T02:34:11Z",
  "EndTime": "2024-12-05T02:34:11Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "887ec188-3243-4782-8dba-03357ed86134",
      "eb2d4986-3c30-4fc6-8058-ae6a3c9bd944"
    ],
    "Companies": [
      "ce9e3cc8-fe5e-4b4d-9622-ec51e51cd465",
      "2f79cf43-218a-44a6-90fd-0877a50560d6"
    ],
    "Groups": [
      "acd56e4e-8445-4252-892b-36784298b8dc",
      "58d96930-7d53-4687-83f9-35de95ec13c6"
    ],
    "Opportunities": [
      "89d3be86-6553-48d5-8190-91ce0ca855c0",
      "1522e164-4322-42d1-94f3-d11309a08848"
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Id of the new history record

globally unique identifier

Response Formats

application/json, text/json

Sample:
"5fc4f194-2dbe-4db2-b949-781378dd903c"