Update document (Lookup) v1.0.0 Help ​

Updates a document description and status in a specified Lookup collection.

How can I use the Step? ​

Use this Step when you need to change the description of a document within a Lookup collection or mark the document as Ready.

How does the Step work? ​

The Step modifies the metadata of a document in a specified collection based on the provided inputs. It supports updating the document's description and changing its status to Ready.

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: an existing Lookup collection containing the document you want to update. This field is required.
  • Document: the name of the document you want to update. This field is required.
  • Document description: a new description for the selected document. It must be between 3 and 2048 characters long.
  • Make document ready: option to change the document's status to Ready.

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:

  • id: [string] the id of the updated document.
  • accountId: [string] the id of the account that the document belongs to.
  • collection: [string] the id of the collection that the document belongs to.
  • name: [string] the name of the document.
  • status: [string] the status of the document.
  • description: [string] the description of the document.
  • updatedAt: [object] an object representing the timestamp when the document was updated.

Example:

json
{
  "id": "string",
  "accountId": "string",
  "collection": "string",
  "name": "string",
  "status": "string",
  "description": "string",
  "updatedAt": {}
}
{
  "id": "string",
  "accountId": "string",
  "collection": "string",
  "name": "string",
  "status": "string",
  "description": "string",
  "updatedAt": {}
}

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