Design / Note Use Cases / Remove a Note
Remove a Note
Overview
In this use case, we’ll walk through permanently deleting a note.
Important Be careful when deleting notes. Once deleted, notes cannot be retrieved.
API Operation
Steps
Send a request to the following endpoint:
DELETE /api/external/v1/notes/{id}
- Use the id path parameter to specify the ID of the note to be deleted.
- Request body is not required.
- Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.
Sample Response
If the note is successfully deleted, 204 Note is removed is returned.
{
204 Note is removed
}