Create Conversation Attribute action

AI-generated summary

Genesys Cloud's Create Conversation Attribute action enables administrators to add custom data to conversations through pre-existing schemas, capturing information beyond the standard conversation data model for use in subsequent Architect actions, analytics, and customer personalization. The action requires configuration of a distinctive name, valid conversation UUID (mandatory for Workflow type flows), pre-existing conversation schema selection, unique Record ID, optional division assignment, and attribute values aligned with the selected schema. The system provides two editing modes for attribute configuration: Standard mode presents predefined fields from the conversation schema, while JSON mode enables direct JSON property editing through Architect's custom JSON editor. Both modes support literal and expression input values, with validation warnings for required fields and a requirement to enter at least one value regardless of schema requirements. The platform supports multiple data types including Boolean, Date, Integer, Number, String, and Queue types, with output generated as JSON objects accessible via dot notation. Error handling is implemented through GeneralExecutionError and InvalidRequest categories, with division-independent access to published tables supported. Usage is metered based on API invocations with rule-based decision pricing applied. The action defines Success and Failure paths, where Success indicates error-free completion and Failure triggers on action completion errors or processing problems. Users manage failure output variables through the arrow interface and configure appropriate follow-up actions in the Failure path. When switching between editing modes, Architect preserves existing values and alerts users to validation errors, offering options to revert or cancel the mode switch. However, complex value structures such as collections prevent reverting to standard mode, and switching from literal to expression mode for the entire input object resets the input data, with the custom JSON editor option becoming unavailable in expression mode. Failure outputs enable flow authors to map errorType and errorMessage variables when the action takes the failure path, supporting flow resiliency through error anticipation and management. Supported errorType values include ActionInvocationLimitExceeded (triggered after five successful action invocations), GeneralError (for general creation errors), InvalidAttribute (for invalid attributes, including unsupported list uniqueness constraints and missing currency codes), and InvalidConversationCustomAttributeSchema (for invalid selected schemas). Success paths indicate error-free system processing without guaranteeing intended data receipt, while failure paths indicate errors during action completion or result processing. Genesys Cloud provides a feedback mechanism for users to evaluate documentation quality and report issues with content accuracy, clarity, and relevance. The feedback form captures whether content was helpful, reasons for feedback, user role within the system, and email information for follow-up purposes, with acknowledgment of the privacy policy required. Users can request community assistance for unresolved questions and access related documentation on Architect functionality, custom data management, conversation schemas, and participant data attributes.

Use the Create Conversation Attribute action to add custom data to a conversation, based on a schema that an administrator previously created in Genesys Cloud. When you create a conversation attribute, you capture data that is not normally found in the conversation data model and save it for later reference, whether in another Architect action, in analytics, or for improved customer personalization.

Once you select a schema, you can assign values to the custom-defined attributes from data available in the flow. For more information, see Custom Conversation Attributes.

Configure the Create Conversation Attribute action

Field	Description
Name	Type a distinctive name for the Create Conversation Attribute action. The label you enter here becomes the action’s name displayed in the task sequence.
Conversation ID	Enter a valid UUID for the conversation. Note: This field is required only for Workflow type flows.
Schema	Click the arrow at the end of this list and select a previously created conversation schema. 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 a unique ID for the conversation attribute record.
Divisions	Select one or more divisions to assign to the conversation attribute record. If your organization does not use divisions, leave this field unassigned.
Attribute	Enter values for the attributes specified in the selected schema. A validation warning indicates required fields. Enter at least one value, even if the schema has no required fields. 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 Architect custom JSON editor. 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

Field Description

Failure Outputs

Field	Description
Failure Outputs	These outputs allow the flow author to map the results of any resulting errorType and errorMessage variables when the Create 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 Create Conversation Attribute action. You can use the following errorType values: ActionInvocationLimitExceeded: If a flow has successfully run the Create Conversation Attribute action five times, any subsequent invocations of the action take the failure path. GeneralError: If there is a general error when creating the conversation attribute record, the action takes the failure path. InvalidAttribute: Occurs 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. InvalidConversationCustomAttributeSchema: Occurs if the schema that you selected is invalid. Note: Click the arrow next to Failure Outputs and expand or collapse the list of variables.

These outputs allow the flow author to map the results of any resulting errorType and errorMessage variables when the Create 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 Create Conversation Attribute action.

You can use the following errorType values:

ActionInvocationLimitExceeded: If a flow has successfully run the Create Conversation Attribute action five times, any subsequent invocations of the action take the failure path.
GeneralError: If there is a general error when creating the conversation attribute record, the action takes the failure path.
InvalidAttribute: Occurs 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.
InvalidConversationCustomAttributeSchema: Occurs if the schema that you selected is invalid.

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

Define success and failure paths

Path	Description
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.

[NEXT] Was this article helpful?

Get user feedback about articles.