Surense icon

Surense

Interact with Surense API

Actions36

Workflow → Update a Workflow

AI-generated

Overview

This node integrates with the Surense API to update workflows within the Surense system. It allows users to modify various attributes of an existing workflow by specifying its unique identifier and providing updated parameters. This is useful in scenarios where workflows need to be programmatically adjusted based on external triggers or data changes, such as updating status, priority, ownership, or other metadata related to a workflow.

Practical examples include:

  • Automatically changing the status of a workflow when certain conditions are met.
  • Updating the assigned user or agency responsible for a workflow.
  • Modifying due dates or notes based on incoming data from other systems.

Properties

Name Meaning
Workflow ID The unique identifier (UUID) of the workflow to update.
Additional Parameters A collection of optional fields to update on the workflow, including:
- Pinned Whether the workflow should be pinned (true/false).
- Type Name or ID The workflow type, selectable from a list or specified via expression.
- Status Name or ID The workflow status, selectable from a list or specified via expression.
- Agency Name or ID The agency associated with the workflow, selectable from a list or specified via expression.
- Owner Name or ID The owner of the workflow, selectable from a list or specified via expression.
- Assignee Name or ID The assignee of the workflow, selectable from a list or specified via expression.
- Due At The due date and time for the workflow.
- Due At Time Set Boolean indicating whether the due time is set.
- Priority Priority level of the workflow; options are 1, 2, or 3.
- Open Date The open date of the workflow.
- Notes Text notes about the workflow.
- Maamad Employment status type with multiple predefined options (e.g., "שכיר", "עצמאי", etc.).
- Payment Method Payment method with predefined options (e.g., "הוראת קבע", "כרטיס אשראי", etc.).
- Employer ID UUID of the employer.
- Employer Contact ID UUID of the employer contact.
- Customer Sign Date Date when customer signed forms.
- Forms Send Date Date when forms were sent.
- Current Product Type Current product type with many predefined insurance and financial product options.
- Current Company ID Numeric ID of the current company.
- Current Company Contact ID UUID of the current company contact.
- Current Product ID Numeric ID of the current product.
- Current Account Policy Number Policy number string for the current account.
- Current Subscription Date Date of current subscription.
- Current Deposit Fee Numeric value representing deposit fee.
- Current Accumulation Fee Numeric value representing accumulation fee.
- Current Accumulation Numeric amount of current accumulation.
- Current Product Status String describing current product status.
- Current Product Class String describing current product class.
- Expected Transfer Accumulation Numeric expected transfer accumulation amount.
- Actual Transfer Accumulation Numeric actual transfer accumulation amount.
- Transfer Regulatory Date Date related to transfer regulation.
- Transfer Actual Date Actual date of transfer.
- Transfer Attribution Date Date of transfer attribution.
- New Company ID Numeric ID of the new company.
- New Company Contact ID UUID of the new company contact.
- New Product ID Numeric ID of the new product.
- New Collective Boolean indicating if it is a new collective.
- New Gemel 190 Boolean indicating if it is a new Gemel 190.
- New Investment Track ID Numeric ID for new investment track.
- New Investment Track ID 2 Numeric ID for second new investment track.
- New Pitsuim Investment Track ID Numeric ID for new Pitsuim investment track.
- New Pitsuim Investment Track ID 2 Numeric ID for second new Pitsuim investment track.
- New Insurance Track ID Numeric ID for new insurance track.
- New Account Policy Number String for new account policy number.
- Pensia Vitur 1 String field (purpose specific to domain).
- Pensia Vitur 2 String field (purpose specific to domain).
- Policy Issuance Date Date when policy was issued.
- Credit Card Last Digits Last digits of credit card number.
- Expected Initial Deposit Date Expected date for initial deposit.
- Actual Initial Deposit Date Actual date of initial deposit.
- Expected Current Premia Numeric expected current premia amount.
- Actual Current Premia Numeric actual current premia amount.
- Expected One-Time Deposit Date Expected date for one-time deposit.
- Actual One-Time Deposit Date Actual date of one-time deposit.
- Expected One-Time Deposit Numeric expected one-time deposit amount.
- Actual One-Time Deposit Numeric actual one-time deposit amount.
- Expected Withdrawal Numeric expected withdrawal amount.
- Actual Withdrawal Numeric actual withdrawal amount.

Output

The node outputs an array of JSON objects corresponding to the results of the update operation(s). Each output item contains the response from the Surense API after attempting to update the specified workflow. The exact structure depends on the API response but generally includes confirmation of updated fields or error messages if the update failed.

No binary data output is indicated.

Dependencies

  • Requires an OAuth2 API credential configured for Surense API access.
  • The node relies on several helper modules and methods internally to map operations and handle pagination, but these are abstracted away from the user.
  • The node expects valid UUIDs and IDs for workflows and related entities.
  • Network connectivity to the Surense API endpoint is required.

Troubleshooting

  • Invalid Workflow ID: If the provided Workflow ID is not in UUID format or does not exist, the API will likely return an error. Ensure the Workflow ID is correct.
  • Missing Required Fields: The Workflow ID is mandatory. Omitting it will cause the node to fail.
  • Authentication Errors: If the OAuth2 credentials are invalid or expired, authentication will fail. Refresh or reconfigure credentials.
  • Invalid Option Values: Selecting or specifying invalid IDs for types, statuses, agencies, or users may cause errors. Use the load options dropdown or valid expressions.
  • Date Format Issues: Dates must be in the specified format (YYYY-MM-DD). Incorrect formats may cause API rejection.
  • API Rate Limits or Connectivity Issues: Network problems or rate limiting by the Surense API can cause failures. Check network and API usage limits.

Error messages returned by the node typically include the API error message in the error field of the output JSON when continueOnFail is enabled.

Links and References

Discussion