Update Custom Field

This help page is for Desktop Studio. This information is also available for CXone Studio.

Icon for the Update Custom Field Digital action.

Updates the value of a custom field in a contact or digitalClosed Any channel, contact, or skill associated with Digital Experience. customer card.


  • This action requires Digital Experience.
  • Before working with digital scripts, learn about the differences between traditional ACD scripts and digital scripts.
  • Use this action with the Get Custom Fields action.

Supported Script Types

The icon for the Digital script type - a computer monitor with a smartphone next to it.


Comparison of Similar Actions

The following actions allow you to access Digital Experiencecustomer cards from digital scripts types: 

To perform the same tasks in supported non-digital scripts, use: 

Input Properties

These properties define data that the action uses when executing.




Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.


The variable that holds the contact ID. The default for this field is {ContactId}.


The variable that holds the contact's customer ID in the CRMClosed Third-party systems that manage such things as contacts, sales information, support details, and case histories.. The default is {CustomerId}.


The ID of the field you want the action to update in the contact or customer card. You can use a variable for this field.


The type of custom fields you want to update. Select Contact to update a custom field in the contact custom fields. Select Customer to update the customer custom fields.


The value you want to update the specified field with. You can use a variable for this field.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.



Default Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.

The path taken when the action doesn't execute properly. For example, when there's an unexpected problem, such as poor connectivity, syntax errors, HTTP error codes, and so on. The ERR variable should be populated with a condensed explanation of the problem.


The path taken when an invalid custom field type is provided.


The path taken when the provided field ID is not valid.


The path taken when the provided target ID is not valid.


Path taken if the action completes without errors and any API calls or data returns were successful (2xx response codes).

Tips and Tricks

You can use this action to handle sensitive data such as credit card numbers or personally-identifiable information (PII). To do this, add it to the Onrelease branch of your script and update the value of the fields to null.