Delete the specified group. — pa_deleteGroup • AirSensor

Sends a request to the PurpleAirAPI API endpoint described at: https://api.purpleair.com/#api-groups-delete-group

pa_deleteGroup(
  api_key = NULL,
  group_id = NULL,
  baseUrl = "https://api.purpleair.com/v1/groups"
)

Arguments

api_key: PurpleAir API WITE key.
group_id: The group_id to be deleted. This group must be owned by the api_key.
baseUrl: URL endpoint for the "Delete Group" API.

Value

No return.

Examples

# \donttest{
# Fail gracefully if any resources are not available
try({

library(AirSensor)

  pa_deleteGroup(
    api_key = PURPLE_AIR_API_READ_KEY,
    group_id = MY_GROUP_ID
  )

}, silent = FALSE)
#> Error in MazamaCoreUtils::stopIfNull(api_key) : 
#>   object 'PURPLE_AIR_API_READ_KEY' not found
# }