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": "ce535f83-ce60-4e18-876c-90a8a319b224", "SeriesId": "2f39d83a-8318-455a-a142-3abcb7e9de27", "AccessorID": "d88f155e-9bf9-4be8-a85f-7300f30a1453", "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": "5c42b382-7997-497c-8289-9102caf3c2c9", "ScheduledByID": "12d090af-05d4-44a9-ac84-cd9974eb04bb", "DeletedDates": [ "2025-10-16T14:53:39Z", "2025-10-16T14:53:39Z" ], "ClearedDates": [ "2025-10-16T14:53:39Z", "2025-10-16T14:53:39Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-10-16T14:53:39Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-10-16T14:53:39Z", "CreateDate": "2025-10-16T14:53:39Z", "OccurTime": "2025-10-16T14:53:39Z", "OccurEndTime": "2025-10-16T14:53:39Z", "StartTime": "2025-10-16T14:53:39Z", "EndTime": "2025-10-16T14:53:39Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "cc763e49-f1df-4593-8ab8-12fbc82f4e82", "65524435-4390-465e-a7d0-f8506c7f0a01" ], "Companies": [ "0cc91851-d3f7-438f-9f23-f1f5c8490e32", "205e3292-ce62-4e12-9370-973e28001747" ], "Groups": [ "c7b164c5-ca20-428a-ac80-4808b26f0159", "4716cb57-823f-4082-841c-ba94124c603e" ], "Opportunities": [ "260000e9-4850-4951-884b-b16bb86dd4d0", "27e03a6e-7ea6-44bc-9b78-b92d2b0167e8" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.