Set Address List activity

  • Release version: Zurich
  • Updated July 31, 2025
  • 1 minute to read

    • The Set Address List activity modifies a Microsoft Exchange address list.

    Use the Optional parameters variable to pass specific values to the Microsoft Exchange server. This activity implements the Microsoft Exchange Set-AddressList command.

    The Exchange server caches the changes from this activity but does not immediately apply them. Use the Update Address List after this activity to apply the changes or wait for the Exchange server to automatically apply cached changes.

    To access this activity in the Workflow Editor, select the Custom tab, and then navigate to Custom Activities > Exchange > Address List.
    Note:
    This activity replaces an Exchange activity by the same name available in releases prior to Geneva. If you have a workflow created in a previous version that uses the deprecated activity, your workflow will continue to work normally after upgrading to Geneva. However, all new workflows must use the custom version of this activity. This activity was built with the PowerShell activity designer, which gives workflow administrators the ability to store input and output variables in the databus.

    Input variables

    Table 1. Set Address List input variables
    Variables Description
    hostname The hostname of the Exchange server with which the activity interacts. Do not enter an IP address in this variable.
    domain The name of the Exchange server's assigned domain.
    identity Name of the address list to modify.
    parameters Optional parameters to pass to the Exchange server written in JavaScript Object Notation (JSON). Exchange activities cannot pass parameters that reference an object, such as a PSCredential object. Plain text is automatically converted to SecureString objects for parameters that require that data type.
    Attempting to save an activity that specifies duplicate parameters, including parameters from activity variables, or incorrectly formatted JSON causes a warning message to appear.
    Note:
    When passing a switch parameter, such as ForceUpgrade, you must use the format "parameter":"true".

    Output variables

    Table 2. Set Address List output variables
    Variable Description
    result Either success or failure.
    error Error message if the operation fails.

    Conditions

    Table 3. Set Address List conditions
    Variable Description
    Success The activity succeeded in modifying the specified address list.
    Failure The activity failed to modify the specified address list.