pa_deleteGroup: Delete the specified group.
In MazamaScience/AirSensor: Process and Display Data from Air Quality Sensors

pa_deleteGroup

R Documentation

Delete the specified group.

Description

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

Usage

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


# 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)

MazamaScience/AirSensor documentation built on April 28, 2023, 11:16 a.m.