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": "6bb5e622-6505-40d0-89ae-15a6702e284c",
  "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-18T23:49:51Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "993589a6-c0c8-41a6-96ec-91abf9d2041f",
  "EditDate": "2024-05-18T23:49:51Z",
  "CreateDate": "2024-05-18T23:49:51Z",
  "StartTime": "2024-05-18T23:49:51Z",
  "EndTime": "2024-05-18T23:49:51Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "26aa00fd-c7eb-4742-92f9-2d726da1b9db",
      "1a802e85-bf43-4cdf-91e4-6970d46f2dd0"
    ],
    "Companies": [
      "34a2c4b4-e688-4f32-a2dc-572c98d4c1c3",
      "6ed1b93f-2ccf-4957-bba2-483fd16954d1"
    ],
    "Groups": [
      "fb98bb74-18a1-41aa-bd7f-e4e8cb2dd68d",
      "02cdd244-9de0-4111-9906-349addc7b626"
    ],
    "Opportunities": [
      "5bb4d49b-7dc5-43c6-942a-27c4b94ffbfa",
      "7ebd7c84-ee66-4110-9010-78eda4cb2cc1"
    ]
  }
}

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:
"2f0e5030-040b-4dc0-9619-cd762c2a1cd4"