Delete one or more existing records from a table using the API.
URL
Use a URL in the following form to invoke the API:
POST https://api.appsheet.com/api/v2/apps/{appId}/tables/{tableName}/Action
Where:
{appId}
specifies the GUID of the AppSheet application. You can obtain the {appId} from the Manage > Integrations > IN pane.{tableName}
specifies the name of the table.
Request body
The HTTP request body contains:
- The Action name
Delete
. -
Optional properties such as
Locale
,Location
, andTimezone
.The
Locale
is used when validatingDate
,Time
,DateTime
,Decimal
,Percent
, andPrice
data values. For example, whenLocale
isen-US
, date values must be entered inMM/DD/YYYY
format. When Locale isen-GB
, date values must be entered inDD/MM/YYYY
format. -
One or more
Rows
elements to be deleted.
EachRow
value may contain field values of the key field values of the record to be deleted. In the following example, the key fields of the record areFirstName
andLastName
.
When you wish to delete one or more rows, it is more efficient to delete all of the rows in a single API call than to delete each row in a separate API call. Using a single API call is significantly more efficient because we make few calls to the data provider.
{
"Action": "Delete",
"Properties": {
"Locale": "en-US",
"Location": "47.623098, -122.330184",
"Timezone": "Pacific Standard Time",
"UserSettings": {
"Option 1": "value1",
"Option 2": "value2"
}
},
"Rows": [
{
"FirstName": "Jan",
"LastName": "Jones"
},
{
"FirstName": "Ian",
"LastName": "Ivans",
}
]
Response body
The API returns the deleted rows in HTTP contents.
{
"Rows": [
{
"_RowNumber": 10,
"FirstName": "Jan",
"LastName": "Jones",
"Age": 33,
"Department": "Accounting",
"Street": "110 Beach Blvd",
"City": "Newport Beach",
"State": "CA",
"Zip": 92661,
"Home Phone": 4257868765,
"Fax": 4253214432,
"Date Hired": "10/31/2014",
"Arrived": "8:15:25",
"Departed": "18:30:33",
"Last Review": "08/31/2017 23:59:59",
"Rating": 0.9950,
"Salary": 3333.45,
"Image": "http://images6.fanpop.com/image/photos/36300000/Emilia-Clarke-image-emilia-clarke-36399128-460-276.jpg"
},
{
"_RowNumber": 11,
"FirstName": "Ian",
"LastName": "Ivans",
"Age": 22,
"Department": "Payroll",
"Street": "118 E Oceanfront",
"City": "Newport Beach",
"State": "CA",
"Zip": 92661,
"Home Phone": 4257868148,
"Fax": 4253217798,
"Date Hired": "09/30/2014",
"Arrived": "7:40:25",
"Departed": "19:22:33",
"Last Review": "09/30/2017 23:59:59",
"Rating": 0.9750,
"Salary": 4444.45,
"Image": "http://images4.fanpop.com/image/photos/16300000/Christopher-Walken-3-christopher-walken-16367376-720-480.jpg"
}
]
}
Response HTTP status codes
See Response HTTP status codes in Invoke an action.
What happens when a record is deleted?
- The key field values you specify in the Incoming webhook request are used to retrieve the record.
- The record or records are deleted from the table.
- Automation workflows, if any, are invoked.
- The deleted record or records are returned in the HTTP content.
Error: Row having key not found
See Troubleshoot API calls for information on the following error:
Row having key '<key value>' not found