Interface CustomerSetCustomFieldAction

Adding a Custom Field to a Customer generates the CustomerCustomFieldAdded Message, removing one generates the CustomerCustomFieldRemoved Message, and updating an existing one generates the CustomerCustomFieldChanged Message.

interface CustomerSetCustomFieldAction {
    action: "setCustomField";
    name: string;
    value?: any;
}

Properties

action name value?

Properties

Readonly action

action: "setCustomField"

Readonly name

name: string

Name of the Custom Field.

Optional Readonly value

value?: any

If value is absent or null, this field will be removed if it exists. If value is provided, it is set for the field defined by name. Trying to remove a field that does not exist will fail with an InvalidOperation error.

Settings

Member Visibility

Theme

On This Page

actionnamevalue