sf_delete_metadata: Delete Object or Field Metadata in Salesforce

In salesforcer: An Implementation of 'Salesforce' APIs Using Tidy Principles

Delete Object or Field Metadata in Salesforce

Description

This function takes a request of named elements in Salesforce and deletes them.

Usage

sf_delete_metadata(
  metadata_type,
  object_names,
  control = list(...),
  ...,
  all_or_none = deprecated(),
  verbose = FALSE
)

Arguments

metadata_type	character; string on what type of metadata to create.
object_names	a character vector of names that we wish to read metadata for
control	list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available look at the documentation for sf_control.
...	arguments passed to sf_control
all_or_none	logical; allows a call to roll back all changes unless all records are processed successfully.
verbose	logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, along with additional diagnostic information where available.

Value

A data.frame containing the creation result for each submitted metadata component

See Also

sf_list_metadata, Salesforce Documentation

Examples

## Not run: 
metadata_info <- sf_delete_metadata(metadata_type = 'CustomObject', 
                                    object_names = c('Custom_Account25__c'))

## End(Not run)

salesforcer documentation built on March 18, 2022, 6:26 p.m.