Delete Collection (Lookup) v1.0.0 Help ​

Removes a collection from Lookup.

How can I use the Step? ​

Delete a collection from Lookup with this Step, removing all related documents, passages, and custom properties. It's great for eliminating redundant or outdated data.

How does the Step work? ​

The Step takes the collection name as input, validates its ID, and then requests the Lookup system to delete the specified collection.

Warning

Deleting the collection and its contents is irreversible. Ensure the collection is meant for deletion and all necessary data has been backed up before proceeding.

Prerequisites ​

  • For custom authentication, ensure proper cross-account settings with Super Admin permission level for account and Flow and the necessary account ID or authentication token.

Input settings ​

  • Collection: Lookup collection to delete. Required.

Cross-account settings ​

To access the Lookup service of another Onereach account, take these steps:

  1. Enable Use custom authentication token.
  2. Choose one of the following access types:
    • Authentication token
    • Account ID
  3. Enter the token or account ID (depending on the chosen access type).

Merge field settings ​

The Step returns the result as a JSON object and stores it under the Merge field name. To learn more about Merge fields and how to work with them, see our Merge fields guide.

Output example ​

The output object properties are as follows:

  • accountId: [string] the id of the account that the collection belongs to.
  • description: [string] the description of the collection.
  • name: [string] the name of the collection.
  • temperature: [number] the temperature of the collection.
  • id: [string] the id of the collection.
  • createdAt: [string] the creation date and time of the collection.
  • updatedAt: [string] the last updated date and time of the collection.

Response structure:

json
{
  "accountId": "string",
  "description": "string",
  "name": "string",
  "temperature": 0,
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "accountId": "string",
  "description": "string",
  "name": "string",
  "temperature": 0,
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

Error handling ​

By default, the Step handles errors using a separate exit. So if any error occurs during the Step execution, the Flow proceeds down the error exit. For more information, see Error and timeout handling.

Reporting ​

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. To learn more, see Reporting events

Service dependencies ​

  • flow builder - v2.28.3
  • event-manager - v2.3.0
  • deployer - v2.6.0
  • library v2.11.3
  • studio v2.64.1

Release notes ​

v1.0.0

  • Initial release