< Back
New-HipchatRoom
Post
NAME New-HipchatRoom
SYNOPSIS
Creates a new HipChat room.
SYNTAX
New-HipchatRoom [-Name] <String> [-Private] -ApiToken <String> [<CommonParameters>]
DESCRIPTION
Creates a new HipChat room using HipChat's API. The room is made public by
default, but can be optionally made private.
PARAMETERS
-Name <String>
Required: The name of the room.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Private [<SwitchParameter>]
Optional: Rooms are made public by default, allowing all users within the
organization to view them. Specifying -Private will make the room private.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ApiToken <String>
Required: Your HipChat API Token. You can obtain an API Token from the
HipChat website by navigating to Account Settings > API Access.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Version: 1.0
Author: Corey Fonseca
Creation Date: 3/17/17
Purpose/Change: Full Functionality
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-HipchatRoom -Name 'Development' -ApiToken 'REXsCauSe553gsoIJg1Gj4zwNsSAwS'
Creates a HipChat room called 'Development' that is publicly accessible to
anyone in your organization.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-HipchatRoom -Name 'Finance' -Private -ApiToken 'REXsCauSe553gsoIJg1Gj4zwNsSAwS'
Creates a private HipChat room called 'Finance' that is invite-only.
RELATED LINKS
SYNOPSIS
Creates a new HipChat room.
SYNTAX
New-HipchatRoom [-Name] <String> [-Private] -ApiToken <String> [<CommonParameters>]
DESCRIPTION
Creates a new HipChat room using HipChat's API. The room is made public by
default, but can be optionally made private.
PARAMETERS
-Name <String>
Required: The name of the room.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Private [<SwitchParameter>]
Optional: Rooms are made public by default, allowing all users within the
organization to view them. Specifying -Private will make the room private.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ApiToken <String>
Required: Your HipChat API Token. You can obtain an API Token from the
HipChat website by navigating to Account Settings > API Access.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Version: 1.0
Author: Corey Fonseca
Creation Date: 3/17/17
Purpose/Change: Full Functionality
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-HipchatRoom -Name 'Development' -ApiToken 'REXsCauSe553gsoIJg1Gj4zwNsSAwS'
Creates a HipChat room called 'Development' that is publicly accessible to
anyone in your organization.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-HipchatRoom -Name 'Finance' -Private -ApiToken 'REXsCauSe553gsoIJg1Gj4zwNsSAwS'
Creates a private HipChat room called 'Finance' that is invite-only.
RELATED LINKS