LUlucid
Data Item

Delete Data Items By Key

Finds all the items whose key values match those specified by the payload and deletes them. The deletion cannot be undone. The deletion will only occur if the user has access to the data source.

delete/collections/{collectionId}/itemsByKey

Request

  • Base URL
    https://data.lucid.app
  • URL
    https://data.lucid.app/collections/{collectionId}/itemsByKey
  • Auth
    OAuth 2
    Authorization code: https://lucid.app/oauth2/authorize
    Token URL: https://api.lucid.co/oauth2/token scopes: data-service.admin

Path parameters

collectionIdinteger required

ID of collection to delete data items from

Request body

keySchemaFieldsstring[]

Fields used to search for items in the collection. If it is not provided, primary keys from the schema are used.

Example request

{
  "targetValues": [
    {
      "fieldValues": [
        "Joey",
        "Ontario"
      ]
    }
  ],
  "keySchemaFields": [
    "first name",
    "last name"
  ]
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.