Adding a Custom Field to a Business Unit generates the BusinessUnitCustomFieldAdded Message, removing one generates the BusinessUnitCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitCustomFieldChanged Message.

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

Properties

Properties

action: "setCustomField"
name: string

Name of the Custom Field.

value?: any

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