POST api/Activities
Create a new Activity
Request Information
URI Parameters
None.
Body Parameters
ActivityName | 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": "8f62ff2a-075c-4040-94d6-9038bbc189c6", "SeriesId": "5f8cfa6d-e6b5-4fab-a625-28567fe610af", "AccessorID": "38e21454-6d5f-441e-84c2-f08bbdd82e40", "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": "5bd11557-e508-406b-832f-d5eff59d37a7", "ScheduledByID": "7229909c-7f2d-47a4-87a3-e5499c3d4a8b", "DeletedDates": [ "2025-09-02T20:31:01Z", "2025-09-02T20:31:01Z" ], "ClearedDates": [ "2025-09-02T20:31:01Z", "2025-09-02T20:31:01Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-09-02T20:31:01Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-09-02T20:31:01Z", "CreateDate": "2025-09-02T20:31:01Z", "OccurTime": "2025-09-02T20:31:01Z", "OccurEndTime": "2025-09-02T20:31:01Z", "StartTime": "2025-09-02T20:31:01Z", "EndTime": "2025-09-02T20:31:01Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "68a9e4b2-8905-4bea-99d5-d013418fa2a3", "5f95602c-b6df-4ea6-8173-bf5630a7b555" ], "Companies": [ "855acfb6-30ef-4a68-a7dd-de0fc03cefa5", "307ee94a-7ce0-4792-9ab4-3590be4966b4" ], "Groups": [ "6d060c64-bbdd-4942-89bd-545e94207eb7", "be37da2b-35a2-48a6-b422-4b55a44384fb" ], "Opportunities": [ "f385d4d5-244e-4bdd-9b6e-fbb1216c4e15", "55b33515-e9ad-4569-95d5-044f03314127" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
globally unique identifierResponse Formats
application/json, text/json
Sample:
"62b88f24-abe2-4828-a37a-d9a46b8f09be"