Sweeppea API v3

Delete Note

Delete a note owned by the authenticated user.

POST https://api-v3.sweeppea.com/notes/delete

Description

This endpoint deletes a note owned by the authenticated user. The note is identified by its NoteToken and can only be deleted by the user who created it.

Authentication

This endpoint requires Bearer token authentication via the Authorization header.

Request Body

Field Type Required Description
NoteToken String Yes Unique identifier of the note to delete (UUID v4)

Code Examples

curl -X POST "https://api-v3.sweeppea.com/notes/delete" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"NoteToken":"uuid-v4-string"}'

Response

{
  "Response": true,
  "Message": "Note Deleted Successfully",
  "Data": {
    "NoteToken": "uuid-v4-string"
  }
}

Error Responses

{
  "Response": false,
  "Message": "Missing Required Field: NoteToken is required",
  "Help": {
    "ExpectedBody": {
      "NoteToken": "string (required) \u2014 UUID v4 of the note"
    }
  },
  "Code": 400
}
{
  "Response": false,
  "Message": "Missing or invalid Bearer token. Send your API token in the Authorization header as: Authorization: Bearer YOUR_API_TOKEN",
  "Code": 401
}
{
  "Response": false,
  "Message": "Invalid API token. It does not match any account.",
  "Code": 403
}
{
  "Response": false,
  "Message": "Note Not Found or Access Denied",
  "Code": 404
}
{
  "Response": false,
  "Message": "Internal server error. Please try again; if it persists, contact support with the time of this request.",
  "Code": 500
}

Important Notes

  • 🔒 Ownership Verification: Users can only delete notes they own
  • 🆔 Note Identification: Notes are identified by their unique NoteToken (UUID v4)
  • ⚠️ Permanent Action: Deletion is permanent and cannot be undone
  • 🔍 Not Found: Returns 404 if note doesn't exist or belongs to another user
© Sweeppea. All rights reserved.