Sweeppea API v3

Update To-Do

Update an existing To-Do item. Admin access required.

POST https://api-v3.sweeppea.com/tickets/updateTodo

Description

This endpoint updates an existing To-Do item identified by its TodoToken. It is restricted to admin users only. All fields except TodoToken are optional — only the fields you provide will be updated (partial update). On success, it returns the full updated To-Do document.

Authentication & Authorization

🛡️ Admin Only

This endpoint is restricted to administrator accounts. Regular users will receive a 403 Forbidden response.

Request Body Parameters

Parameter Type Required Description
TodoToken string ✅ Yes UUID v4 of the To-Do to update
Title string No New title (max 200 characters)
Description string No New description (max 20,000 characters)
Priority number No 1 = Low, 2 = Medium, 3 = High
ResourceAffected string No Resource this To-Do relates to (e.g. "renaissance", "api", "aws", "general")
Pin boolean No Pin this To-Do to the top
Deadline string No ISO date string, or null to clear the deadline
Status boolean No false = Pending, true = Completed
Completion number No Completion percentage 0–100

Request Body

Field Type Required Description
TodoToken String Yes UUID v4 of the To-Do to update
Title String No New title (max 200 characters)
Description String No New description (max 20,000 characters)
Priority Number No 1 = Low, 2 = Medium, 3 = High
ResourceAffected String No Resource this To-Do relates to (e.g. "renaissance", "api", "aws", "general")
Pin Boolean No Pin this To-Do to the top
Deadline String No ISO date string, or null to clear the deadline
Status Boolean No false = Pending, true = Completed
Completion Number No Completion percentage 0–100

Code Examples

curl -X POST "https://api-v3.sweeppea.com/tickets/updateTodo" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "TodoToken": "uuid-v4-string",
    "Title": "Updated title",
    "Priority": 2,
    "Status": true,
    "Completion": 100
  }'

Response

{
  "Response": true,
  "Data": {
    "TodoToken": "uuid-v4-string",
    "CreationDate": "2025-06-01T10:00:00.000Z",
    "Deadline": null,
    "Title": "Updated title",
    "Description": "...",
    "Priority": 2,
    "ResourceAffected": "api",
    "Pin": true,
    "Status": true,
    "Views": 3,
    "Completion": 100
  }
}

Error Responses

{
  "Response": false,
  "Message": "Missing or Invalid TodoToken",
  "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": "Admin Access Required",
  "Code": 403
}
{
  "Response": false,
  "Message": "To-Do Not Found",
  "Code": 404
}
{
  "Response": false,
  "Message": "Internal server error. Please try again; if it persists, contact support with the time of this request.",
  "Code": 500
}
© Sweeppea. All rights reserved.