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": "040ab43f-ddd5-41f2-b378-76559ec78bcd",
  "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-05-15T03:12:30Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "a60f7b1c-c642-4f11-9045-d6a7cc18a55a",
  "EditDate": "2024-05-15T03:12:30Z",
  "CreateDate": "2024-05-15T03:12:30Z",
  "StartTime": "2024-05-15T03:12:30Z",
  "EndTime": "2024-05-15T03:12:30Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "a1fa08ca-54d8-458f-b338-2a9fe83a58c8",
      "27d4d6e8-859a-47ce-b2c4-261804c51b62"
    ],
    "Companies": [
      "3663048b-ca9f-481b-87e0-a4d7d6256434",
      "7d43c63d-4219-43cf-b01d-07db5a2ffb41"
    ],
    "Groups": [
      "23e3c630-30d0-44f9-a792-8d19e471c8b2",
      "3ddb32a2-aef0-4501-ade3-05727f66fc4a"
    ],
    "Opportunities": [
      "65623838-62c5-43f0-a03e-fa3c68f9f4fa",
      "fe996b54-33e8-4d3a-b464-3e9c071920e6"
    ]
  }
}

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:
"28b61a71-2e60-4510-8f08-8886474f4c16"