Remove-SalesforceRecord

NAME Remove-SalesforceRecord



SYNOPSIS

Removes a record of the specifed type.





SYNTAX

Remove-SalesforceRecord -ObjectType <String> -RecordId <String[]> -Connection <Hashtable> [<CommonParameters>]



Remove-SalesforceRecord -ObjectType <String> -InputObject <PSObject[]> -Connection <Hashtable> [<CommonParameters>]





DESCRIPTION







PARAMETERS

-ObjectType <String>

Specifies the type of object to removed. For example: Account.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RecordId <String[]>

Identifies the record to be removed.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Connection <Hashtable>

Specifies connection information to the Salesforce site. For example:

@{

ServerUrl='<Salesforce Site URL>';

LoginUrl='https://login.salesforce.com/services/oauth2/token';

Username='<user>';

Password='<password>';

SecurityToken='<user security token>';

ClientId='<client ID (consumer key) for the Salesforce connected app>';

ClientSecret='<client secret (consumer secret) for the Salesforce connected app>';

LicenseKey='<license key>';

SessionTimeoutMinutes=15;

SkipCertificateValidation=$false

}



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-InputObject <PSObject[]>

Object representing the record that is to be removed. Use Get-SalesforceRecord to retrieve input object.



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

System.Management.Automation.PSObject[]







OUTPUTS

System.String

Record ID of the removed record. The record ID is no longer valid.







RELATED LINKS