delete_glossary {deeplr} | R Documentation |
Delete a Glossary with the DeepL API Pro
Description
delete_glossary
deletes a glossary from your DeepL API Pro account using its unique ID.
Usage
delete_glossary(glossary_id, auth_key)
Arguments
glossary_id |
A string specifying the unique ID of the glossary to be deleted. |
auth_key |
A string representing the authentication key for the DeepL API Pro.
If not provided, the function will attempt to retrieve the key from the environment
variable |
Details
Deleting a glossary is permanent and cannot be undone. If needed, you can back up
glossary entries in advance using get_glossary_entries
.
To use this function, you must obtain an authentication key by registering for a DeepL API Pro account at DeepL API Pro.
For a list of available glossaries and their metadata, see list_glossaries
.
Value
No return value. A confirmation message is printed upon successful deletion.
References
DeepL API Documentation on Glossary Deletion
Examples
## Not run:
glossary_id <- "example-glossary-id"
delete_glossary(glossary_id)
## End(Not run)