PUT api/Activities/{id}
Update an existing Activity. This is not a partial update therefore, please pass in the full activity object to your request. For partial updates, use the PATCH endpoint
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Activity ID |
globally unique identifier |
Required |
Body Parameters
Serialized Activity record in the body of the request
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": "2240d62c-cece-48ba-aaf5-2595053f6c91", "SeriesId": "6d5c5b6c-c1e2-4850-9cd4-d0d2482e6714", "AccessorID": "c8c9b18b-e5cb-48a4-b0a3-15c1a95a8f86", "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": "9d8b9c56-fc8f-491f-b4f6-43e2a4b2c14d", "ScheduledByID": "09d9e49c-8272-4f6e-8c88-1451567ae60b", "DeletedDates": [ "2025-09-02T20:33:28Z", "2025-09-02T20:33:28Z" ], "ClearedDates": [ "2025-09-02T20:33:28Z", "2025-09-02T20:33:28Z" ], "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:33:28Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-09-02T20:33:28Z", "CreateDate": "2025-09-02T20:33:28Z", "OccurTime": "2025-09-02T20:33:28Z", "OccurEndTime": "2025-09-02T20:33:28Z", "StartTime": "2025-09-02T20:33:28Z", "EndTime": "2025-09-02T20:33:28Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "7fa95b18-729d-47d6-9ef9-f2e06b6ccbf3", "97bf9b6d-e39f-43e3-8941-509e14e0f3d9" ], "Companies": [ "0d36b4dc-71ef-437a-b002-35586b8b3466", "a32350d2-c611-4079-95d6-4dbb47aa91b1" ], "Groups": [ "a63ad34e-6047-406b-9781-9f16cacb50b2", "ff2b85a9-ac85-4be8-9fda-38266cd5d66b" ], "Opportunities": [ "e17a138a-fa69-4abc-8233-4e8a97b8eca0", "e661e305-bed8-40ea-be10-300419420087" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.