Skip to main content

Add-AtriaWorkSpaceCustomerRoleItem

SYNOPSIS​

Adds one or more workspace list items to a specific customer role.

SYNTAX​

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

DESCRIPTION​

Assigns one or more list items to a customer role. The function sends a POST request to the API endpoint with an action="Add" directive to associate the specified list item IDs with the provided role.

PARAMETERS​

  • CustomerId <Int> (Required) The unique identifier (ID) of the customer for whom the role is managed.

  • RoleId <Int> (Required) The unique identifier (ID) of the role to which list items are being assigned.

  • ListItemId <Int[]> (Required) One or more workspace list item IDs to assign to the specified role.

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

OUTPUTS​

Returns the API response confirming the role-item assignment.

EXAMPLES​

Example 1​

Add-AtriaWorkSpaceCustomerRoleItem -CustomerId 1234 -RoleId 42 -ListItemId 1001,1002

Adds list items with IDs 1001 and 1002 to role 42 under customer 1234.

NOTES​

Ensure that you have successfully authenticated using Connect-AtriaApi before invoking this function. The authenticated token is required for all API requests.