Delete Passage (Lookup) v1.0.0 Help ​

Removes a passage from the specified Lookup collection.

How can I use the Step? ​

Use this Step to remove an individual passage from a Lookup collection. It's useful for content management, especially when certain passages are outdated, irrelevant, or were added incorrectly.

How does the Step work? ​

The Step verifies and then deletes the specified passage from the Lookup collection, handling validations, timeouts, and errors for a smooth deletion process.

Warning

Deleting a passage is permanent and irretrievable.

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: a Lookup collection. Required.
  • Passage: a passage within the selected Lookup collection to delete.

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 has the following properties:

  • content: [string] text of the deleted passage.
  • document: [array] an array of objects representing references to the document from which deleted passage. Each object has two properties:
    • beacon: [string] a unique identifier or locator for the document within a specific system or database.
    • href: [string] a relative URL to the document, valid for direct access or reference.
  • testProperty: [number] a custom property with int type added to the passage for testing purposes. If the passage has associated properties, they are all displayed in the output object.
  • id: [string] the unique identifier of the deleted passage.
  • createdAt: [string] the timestamp indicating when the passage was initially created.
  • updatedAt: [string] the timestamp indicating when the passage was last updated.

Example:

json
{
  "content": "string",
  "document": [
    {
      "beacon": "string",
      "href": "string"
    }
  ],
  "testProperty": 0,
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string",
}
{
  "content": "string",
  "document": [
    {
      "beacon": "string",
      "href": "string"
    }
  ],
  "testProperty": 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