POST api/Activities
Create a new Activity
Request Information
URI Parameters
None.
Body Parameters
Activity| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| SeriesId | globally unique identifier |
None. |
|
| AccessorID | globally unique identifier |
None. |
|
| IsCleared | boolean |
None. |
|
| IsAlarmCreated | boolean |
None. |
|
| IsAlarmed | boolean |
None. |
|
| LeadMinutes | integer |
None. |
|
| AlarmDue | string |
None. |
|
| ExternalID | string |
None. |
|
| Location | string |
None. |
|
| IsTimeless | boolean |
None. |
|
| IsPrivate | boolean |
None. |
|
| PriorityId | integer |
None. |
|
| ActivityPriorityName | string |
None. |
|
| ActivityTypeId | integer |
None. |
|
| ActivityTypeName | string |
None. |
|
| Subject | string |
None. |
|
| ScheduledBy | string |
None. |
|
| ScheduledFor | string |
None. |
|
| ScheduledForID | globally unique identifier |
None. |
|
| ScheduledByID | globally unique identifier |
None. |
|
| DeletedDates | Collection of date |
None. |
|
| ClearedDates | Collection of date |
None. |
|
| RecurSpec | ActivityRecurSpec |
None. |
|
| EditDate | date |
None. |
|
| CreateDate | date |
None. |
|
| OccurTime | date |
None. |
|
| OccurEndTime | 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": "1298ce24-fb5a-4b30-9966-d2e52330ef11",
"SeriesId": "e91499e0-0bf5-462e-8673-2ff10e67f4bc",
"AccessorID": "c81fd1ac-ec35-4a7f-befa-2191aa7bcda0",
"IsCleared": true,
"IsAlarmCreated": true,
"IsAlarmed": true,
"LeadMinutes": 7,
"AlarmDue": "sample string 8",
"ExternalID": "sample string 9",
"Location": "sample string 10",
"IsTimeless": true,
"IsPrivate": true,
"PriorityId": 13,
"ActivityPriorityName": "sample string 14",
"ActivityTypeId": 15,
"ActivityTypeName": "sample string 16",
"Subject": "sample string 17",
"ScheduledBy": "sample string 18",
"ScheduledFor": "sample string 19",
"ScheduledForID": "c1fc4167-5589-43d3-9eea-1bf527d4f31a",
"ScheduledByID": "e68d7cc9-d6e0-499a-8a23-91da20d1ab1e",
"DeletedDates": [
"2026-01-14T05:20:43Z",
"2026-01-14T05:20:43Z"
],
"ClearedDates": [
"2026-01-14T05:20:43Z",
"2026-01-14T05:20:43Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-14T05:20:43Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-14T05:20:43Z",
"CreateDate": "2026-01-14T05:20:43Z",
"OccurTime": "2026-01-14T05:20:43Z",
"OccurEndTime": "2026-01-14T05:20:43Z",
"StartTime": "2026-01-14T05:20:43Z",
"EndTime": "2026-01-14T05:20:43Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"34190085-62a4-4390-a0b6-0f9e3106edb5",
"5385e757-6252-465c-854b-7a775191599c"
],
"Companies": [
"9018ebe9-0f3b-4eeb-ae6f-851880ec9ea6",
"19804ce8-1472-46ac-a3d0-e2cfb23b1be9"
],
"Groups": [
"07fcfc4a-970e-406e-93b2-cffd802b86cf",
"f7fc68e8-3c86-4e6f-99b0-5fb15d52d9aa"
],
"Opportunities": [
"162e5003-c680-422c-aff0-1690c1ba0a1a",
"dee80233-8030-4920-8691-73e728454867"
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
globally unique identifierResponse Formats
application/json, text/json
Sample:
"672333eb-8793-42aa-9736-c32b26c9b319"