Update Passage (Lookup) v1.0.0 Help ​

Updates the content of a specific passage within a document in the Lookup collection.

How can I use the Step? ​

Use this Step to modify the content of an existing passage in a Lookup collection. You can also update additional properties associated with the passage if they are defined in the collection schema.

How does the Step work? ​

The Step updates a passage in the specified collection based on the provided inputs. It supports changing the content of the passage and modifying its additional properties.

Prerequisites ​

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

Input settings ​

• Collection: a Lookup collection containing the passage you wish to update. Required.
• Passage: a passage within the selected Lookup collection to update. Required.
• Content: a new text for the passage. The character limit is between 3 and 5000. Required.

Advanced settings ​

• Additional properties: a field to add passage properties if they exist in the collection schema. Optional.

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] the updated content of the passage.
• document: [array] an array of objects representing the document associated with the passage. Each object has two properties:
  • beacon: [string] a unique identifier or locator for the document within a specific system or database.
  • href: [string] the href value of the document, valid for direct access or reference.
• newProperty: [string] a new property that may be added to the passage.
• id: [string] a unique identifier of the passage.
• createdAt: [string] the timestamp of when the passage was created.
• updatedAt: [string] the timestamp of when the passage was updated.

Example:

{
  "content": "string",
  "document": [
    {
      "beacon": "string",
      "href": "string"
    }
  ],
  "newProperty": "string",
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

{
  "content": "string",
  "document": [
    {
      "beacon": "string",
      "href": "string"
    }
  ],
  "newProperty": "string",
  "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