Update Record Activity

Updates the activity for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   update_record_activity

App TypeAgency
Authorization TypeAccess token
URI /v4/records/{recordId}/activities/{id}?lang={lang}&fields={fields}
HTTP MethodPUT
Automation Version(s)7.3.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
activityStatusactivityStatus{}No7.3.3.2
activityStatus.textstringNoThe localized display text.7.3.2
activityStatus.valuestringNoThe value for the specified parameter.7.3.2
assignedDepartmentassignedDepartment{}No Get All Departments The department responsible for the action.7.3.3
assignedDepartment.textstringNoThe localized display text.7.3.2
assignedDepartment.valuestringNoThe value for the specified parameter.7.3.2
assignedUserassignedUser{}NoThe staff member responsible for the action.7.3.3
assignedUser.textstringNoThe localized display text.7.3.2
assignedUser.valuestringNoThe value for the specified parameter.7.3.2
descriptionstringNoThe description of the record or item.7.3.3
dueDatedateTimeNoThe desired completion date of the task.7.3.3
namestringNoThe full name for the application contact.7.3.3
prioritypriority{}No Get All Activity Priorities The priority level assigned to the activity.7.3.3
priority.textstringNoThe localized display text.7.3.2
priority.valuestringNoThe value for the specified parameter.7.3.2
startDatedateTimeNoThe date the contact became active.7.3.3
statusstatus{}No Get All Activity Statuses The activity status.7.3.3
status.textstringNoThe localized display text.7.3.2
status.valuestringNoThe value for the specified parameter.7.3.2
typetype{}No Get All Activity Types The activity type.7.3.3
type.textstringNoThe localized display text.7.3.2
type.valuestringNoThe value for the specified parameter.7.3.2
fieldsstringNoComma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
idstringYesThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
langStringNoIndicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
resultresult{}7.3.2
result.codestringA code identifying an associated item7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.2
result.messagestringA text message related to the operation.7.3.2
statusintegerThe record status.7.3.3