Public/Set/Set-HaloCRMNote.ps1
|
Function Set-HaloCRMNote { <# .SYNOPSIS Updates a CRM note via the Halo API. .DESCRIPTION Function to send a CRM note update request to the Halo API .OUTPUTS Outputs an object containing the response from the web request. #> [CmdletBinding( SupportsShouldProcess = $True )] [OutputType([PSCustomObject])] Param ( # Object containing properties and values used to update an existing CRM note. [Parameter( Mandatory = $True, ValueFromPipeline = $True )] [PSCustomObject]$CRMNote ) Invoke-HaloPreFlightCheck $CommandName = $MyInvocation.InvocationName try { $HaloCRMNoteParams = @{ CRMNoteID = $CRMNote.id ClientID = [int]$CRMNote.client_id } $ObjectToUpdate = Get-HaloCRMNote @HaloCRMNoteParams if ($ObjectToUpdate) { if ($PSCmdlet.ShouldProcess("CRM Note $($ObjectToUpdate.id) by $($ObjectToUpdate.who_agentid)", 'Update')) { New-HaloPOSTRequest -Object $CRMNote -Endpoint 'crmnote' -Update } } else { Throw 'CRM Note was not found in Halo to update.' } } catch { $Command = $CommandName -Replace '-', '' $ErrorRecord = @{ ExceptionType = 'System.Exception' ErrorMessage = "$($CommandName) failed." InnerException = $_.Exception ErrorID = "Halo$($Command)CommandFailed" ErrorCategory = 'ReadError' TargetObject = $_.TargetObject ErrorDetails = $_.ErrorDetails BubbleUpDetails = $False } $CommandError = New-HaloErrorRecord @ErrorRecord $PSCmdlet.ThrowTerminatingError($CommandError) } } |