Interface MyBusinessUnitSetAddressCustomFieldAction

Adding a Custom Field to an Address of a Business Unit generates the BusinessUnitAddressCustomFieldAdded Message, removing one generates the BusinessUnitAddressCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitAddressCustomFieldChanged Message.

interface MyBusinessUnitSetAddressCustomFieldAction {
    action: "setAddressCustomField";
    addressId: string;
    name: string;
    value?: any;
}

Properties

action addressId name value?

Properties

Readonly action

action: "setAddressCustomField"

Readonly addressId

addressId: string

ID of the address to be extended.

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

Settings

Member Visibility

Theme

On This Page

actionaddressIdnamevalue