Skip to main content

Set-AtriaWorkSpaceCustomerRoleItem

SYNOPSIS​

Sets (overwrites) the list items assigned to a specific customer role.

SYNTAX​

Set-AtriaWorkSpaceCustomerRoleItem -CustomerId <Int> -RoleId <Int> -ListItemId <Int[]> [<CommonParameters>]

DESCRIPTION​

This function replaces all existing list items assigned to a given role under a specific customer. It sends a POST request with action="Set" to overwrite the current role-to-item relationships.

PARAMETERS​

  • CustomerId <Int> (Required) The ID of the customer whose role is being modified.

  • RoleId <Int> (Required) The ID of the role for which list items will be replaced.

  • ListItemId <Int[]> (Required) One or more list item IDs to assign to the role. These replace all existing assignments.

  • <CommonParameters> Supports standard PowerShell common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. More info: about_CommonParameters

OUTPUTS​

Returns the API response confirming the updated role-item assignment.

EXAMPLES​

Example 1​

Set-AtriaWorkSpaceCustomerRoleItem -CustomerId 1234 -RoleId 5678 -ListItemId 1001,1002

This replaces all list items for role 5678 with 1001 and 1002 for customer 1234.

NOTES​

Ensure you’ve authenticated using Connect-AtriaApi before calling this function.