e New-TdBranch | Welcome to TOPdeskPS

Main | Command Reference | Quick Start

Welcome to TOPdeskPS

PowerShell module to interact with the TOPdesk REST Api

New-TdBranch

SYNOPSIS

Creates a new branch

SYNTAX

New-TdBranch [-Name] <String> [[-Specification] <String>] [[-ClientReferenceNumber] <String>]
 [[-Phone] <String>] [[-fax] <String>] [[-Email] <String>] [[-Website] <String>] [-BranchType] <String>
 [[-HeadBranchId] <Object>] [[-Address] <Hashtable>] [[-PostalAddress] <Hashtable>]
 [[-OptionalFields1] <Hashtable>] [[-OptionalFields2] <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

creates a new branch

EXAMPLES

EXAMPLE 1

New-TdBranch -Name 'New Branch' -Branch Type 'independentBranch' -Phone '555-555-5555'

creates a new branch

EXAMPLE 2

New-TdBranch -Name 'Subsidiary of AlphaBranch' -BranchType 'hasAHeadBranch' -HeadBranchId (Get-TdBranch -name 'AlphaBranch').id

PARAMETERS

-Name

Name of the branch

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Specification

Branch specification

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClientReferenceNumber

Client Reference Number

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Phone

Phone Number

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-fax

Fax Number

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Email

email address

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Website

Website URL

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BranchType

Define the type of branch. Optional values: ‘independentBranch’, ‘headBranch’, ‘hasAHeadBranch’

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HeadBranchId

ID of head branch

Type: Object
Parameter Sets: (All)
Aliases: HeadBranch

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Address

Address

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PostalAddress

Postal Address

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OptionalFields1

optional

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OptionalFields2

optional

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

[https://developers.topdesk.com/explorer/?page=supporting-files?/

TODO Update help](https://developers.topdesk.com/explorer/?page=supporting-files?/

TODO Update help)