Remove-HipchatRoom

NAME Remove-HipchatRoom



SYNOPSIS

Removes an existing HipChat room and kicks all users.





SYNTAX

Remove-HipchatRoom [-Name] <String> -ApiToken <String> [<CommonParameters>]





DESCRIPTION

Removes an existing HipChat room using HipChat's API. If there are any

users in the room, they will automatically be removed from the room.





PARAMETERS

-Name <String>

Required: The name of the room. The name must be entered exactly as it

appears on HipChat.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

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:\\>Remove-HipchatRoom 'Development' -ApiToken 'REXsCauSe553gsoIJg1Gj4zwNsSAwS'



Removes the HipChat room called 'Development' and kicks all users.











RELATED LINKS