Matt Aitken
30 lines
1.1 KiB
Plaintext
30 lines
1.1 KiB
Plaintext
---
|
|
title: Delete Record
|
|
sidebarTitle: Delete Record
|
|
description: Delete a single record.
|
|
---
|
|
|
|
## Params
|
|
|
|
<ParamField path="key" type="string" required={true}>
|
|
A unique string. Please see the [Keys and Resumability](/guides/resumability)
|
|
doc for more info.
|
|
</ParamField><ParamField path="params" type="object" required={true}>
|
|
Delete Record Input
|
|
<Expandable title="properties" defaultOpen={true}><ParamField path="baseId" type="string" required={true}>
|
|
The ID of the base
|
|
</ParamField><ParamField path="tableIdOrName" type="string" required={true}>
|
|
The name or id of the table
|
|
</ParamField><ParamField path="recordId" type="string" required={true}>
|
|
The ID of the record
|
|
</ParamField></Expandable></ParamField>
|
|
|
|
## Response
|
|
|
|
<ResponseField path="response" type="object" required={true}>
|
|
Delete Record Output
|
|
<Expandable title="properties" defaultOpen={false}><ResponseField path="id" type="string" required={true}>
|
|
Record ID
|
|
</ResponseField><ResponseField path="deleted" type="boolean" required={true}>
|
|
Whether the record was deleted
|
|
</ResponseField></Expandable></ResponseField> |