You can delete one or more existing records from a table.

URL

Use a URL in the following form to invoke the API.

POST https://api.appsheet.com/api/v1/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.

Body

The HTTP Body contains:

  1. The Action name “Delete”.
  2. Optional properties such as Locale, Location, and Timezone.
  3. One, or more, Row values to be deleted. Each individual Row value must include the key field values of the record to be deleted. In the following example, the key fields of the record are "FirstName" and "LastName".

    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",
},
"Rows": [
{
"FirstName": "Jan",
"LastName": "Jones"
},
{
"FirstName": "Ian",
"LastName": "Ivans",
}
]

When a Record is Deleted

  1. The key field values you specify in the Incoming Webhook request are used to retrieve the record.
  2. The record or records are deleted from the table.
  3. Workflow rules, if any, are invoked.

Row Having Key Not Found

See topic "Row Having Key Not Found" here.

Did this answer your question?