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": "7f1e7354-818a-4371-a0e0-09d6104b7386", "SeriesId": "df20975d-c136-4907-8e88-d7b79ad8e085", "AccessorID": "17c6dcce-4732-4b3d-82e1-4fc4e42d1c68", "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": "491590fb-fc32-46ad-ac1e-03706744d8af", "ScheduledByID": "824ecbdd-343f-4438-90ae-a1645b4045f5", "DeletedDates": [ "2025-07-18T23:59:57Z", "2025-07-18T23:59:57Z" ], "ClearedDates": [ "2025-07-18T23:59:57Z", "2025-07-18T23:59:57Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-07-18T23:59:57Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-07-18T23:59:57Z", "CreateDate": "2025-07-18T23:59:57Z", "OccurTime": "2025-07-18T23:59:57Z", "OccurEndTime": "2025-07-18T23:59:57Z", "StartTime": "2025-07-18T23:59:57Z", "EndTime": "2025-07-18T23:59:57Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "2becbf12-0da5-46ae-9a70-7f394a97cce7", "7c7bd151-29ea-4ca9-ab28-ac0159d22036" ], "Companies": [ "e1749035-3525-448a-8c8f-7e0f528a2eb2", "ae62da28-7dcc-4fbd-b3c0-b9be097a5070" ], "Groups": [ "8f1e4f18-f69b-46ce-8ec9-5f308538d6fe", "79434d1d-d99a-4ac9-87fa-52348aeedeaa" ], "Opportunities": [ "33d26352-a96e-4c25-9222-8e35b5c21dba", "3752bfb7-6c95-408f-9b08-23c73b59d66f" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.