Skip to main content

Update Conversation Attribute action

Use the Update Conversation Attribute action to update an existing conversation attribute record. This update action allows you to update a conversation attribute record fully or partially as long as you adhere to its schema.

Configure the Update Conversation Attribute action

FieldDescription
NameType a distinctive name for the Update Conversation Attribute action. The label you enter here becomes the action’s name displayed in the task sequence.
Conversation ID

Enter the valid UUID of the conversation that contains the record you want to update.

Note: This field is applicable only for Workflow type flows.

Schema

Click the arrow at the end of this list and select a previously created that represents the record you want to update. To narrow the selection, type the first few letters of the schema name.

Conversation attributes appear in the Attribute field, based on the schema you select.

Record ID

Enter the unique ID of the conversation attribute record that you want to update.

Divisions

Select one or more divisions to assign to the conversation attribute record. If your organization does not use divisions, leave this field unassigned.

Note: If the existing record has one or more divisions assigned and you leave this field unassigned, the Update Conversation Attribute action removes the existing divisions assignment. 

Attribute

Allows you to update existing values for the attributes specified in the selected schema. Required fields are indicated by a validation warning. Even if there are no required fields in the schema, at least one value is always required.

Select Standard or JSON to toggle between the standard and JSON editing modes.

  • Standard: Allows you to define values in the provided attribute fields. The fields that appear come from the conversation schema. 
  • JSON: Allows you to define values directly using JSON properties. In this mode, you can access Architect’s custom JSON editor and its tools to define values for the conversation attributes. For more information about using the custom JSON editor, see .

Both the standard and JSON editing modes allow literals and expressions as the input values. If you have not set a property and its value in JSON mode, the corresponding field in standard mode indicates that no value is specified. 

Notes:

  • Architect retains the existing values when you switch between editing modes. If there are any validation errors at the time of switching the mode, Architect alerts you and provides an option to revert to the previous valid values or cancel switching the mode. 
  • If the custom JSON data has any complex value structure such as collections, you cannot switch back to standard editing mode.
  • Switching from literal to expression mode for the entire input object resets the input data. The option to access the custom JSON editor also disappears in expression mode.
Result

Assign a variable name to the conversation attribute record for further use in the flow.

Define failure outputs

FieldDescription
Failure Outputs

These outputs allow the flow author to map the results of any resulting errorType and errorMessage variables when the Update Conversation Attribute action takes the failure path. The failure outputs help you anticipate potential issues and manage them effectively, improving your flow’s resiliency.

  • errorType: A nonempty string that contains the type or category of the error.
  • errorMessage: A non-localized failure message. The string can be empty or NOT_SET.

Note: Hover over the information icon next to errorType to display the list of allowable errorType values.

Select the variables that you want to assign to the failure data values returned by the Update Conversation Attribute action.

You can use the following errorType values:

  • ActionInvocationLimitExceeded: If a flow has successfully run the Update Conversation Attribute action five times, any subsequent invocations of the action take the failure path.
  • ConversationCustomAttributeRecordNotFound: Occurs if you attempt to update a record that does not exist.
  • GeneralError: If there is a general error when updating the conversation attribute record, the action takes the failure path.
  • InvalidAttributeOccurs if an invalid attribute is provided. While Architect detects most types of invalid attributes through UI flow validation, it does not support all constraints.
    • Uniqueness: Lists can sometimes require item uniqueness, which Architect does not currently support.
    • Required fields: Currency fields require both an amount and a currency code. Passing only one value (for example, amount only) triggers this error.
    • Literal-only validation: Most input validation methods check only the literal values. If you pass a variable like var.emptyString into a string field that requires at least one character, it results in a runtime InvalidAttribute error.

Note: Click the arrow next to Failure Outputs and expand or collapse the list of variables.

Define success and failure paths

PathDescription
Success

A completed Success path indicates that the system encounters no errors during the process. It is not a measure of whether the system receives data that is the intended result or functionality.

Failure

This path indicates that there was an error attempting to complete the action or a problem processing the results from the Create Conversation Attribute action. Drag the appropriate action below the Failure path.