Skip to main content

Update Record

PATCH or PUT

https://app.smartsuite.com/api/v1/applications/[tableId]/records/[recordId]/

Updates a record in the specified App.

Example Request
curl -X PATCH https://app.smartsuite.com/api/v1/applications/6451093119bcf22befaed847/records/645109df887911e1871054b7/ \
-H "Authorization: Token YOUR_API_KEY" \
-H "ACCOUNT-ID: WORKSPACE_ID" \
-H "Content-Type: application/json" \
--data '{
"title": "Record 1"
}'

The update endpoint supports two types of record updates, with a PUT request performing a “destructive” update that clears all values that are not specified in the update, and a PATCH request updating just those fields included in the request.

The following SmartSuite Fields are system-generated, computed or set by aggregate user actions (ex. voting) and cannot be set via API:

  • Auto Number
  • Count
  • First Created
  • Formula
  • Last Updated
  • Record ID
  • Rollup
  • Vote

Path Parameters

ParamTypeDescription
tableIdstringThe Id of the Table (App) in which to create the record.
recordIdstringThe Id of the record to apply updates to.

Request Body

ParamTypeOptionalDescription
record objectobjectNoA record object representing the new record to be updated.

Response

200 Response - Example

{
"title": "Record 1",
"description": {
"data": {},
"html": "<div class=\"rendered\">\n \n</div>"
},
"assigned_to": [
"5dd812b9d8b7863532d3ddd2",
"5e6ec7dadc8a90f33bcb02c9"
],
"status": {
"value": "in_progress"
},
"due_date": {
"from_date": {
"date": "2021-09-03T03:00:00Z",
"include_time": true
},
"to_date": {
"date": "2021-09-04T03:15:00Z",
"include_time": true
},
"is_overdue": false
},
"priority": "1",
"sef1a6a113": {
"from_date": {
"date": "2021-09-01T00:00:00Z",
"include_time": false
},
"to_date": {
"date": "2021-09-03T00:00:00Z",
"include_time": false
}
}
}