Skip to main content
PUT /api/user-challenges/:id/complete Requires authentication.
​
Authorization
string
required
Bearer token obtained from /api/auth/login or /api/auth/signup. Format: Bearer <token>.
Completing a challenge sets its status to COMPLETED and records the current timestamp in completed_at. Once completed, the user is free to accept a new challenge.

​
Path parameters

​
id
number
required
The numeric ID of the user challenge to complete.

​
Example

curl --request PUT \
  --url http://localhost:3000/api/user-challenges/14/complete \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

​
Response

200 OK Returns the updated user challenge object with status set to COMPLETED and completed_at set to the current timestamp.
​
id
number
required
Unique numeric identifier for this user challenge.
​
user_id
string
required
UUID of the authenticated user.
​
template_id
number
required
ID of the challenge template this challenge is based on.
​
status
string
required
Updated status. Always COMPLETED after this operation.
​
start_date
string
required
ISO 8601 timestamp of when the challenge was started.
​
completed_at
string
required
ISO 8601 timestamp of when the challenge was marked as completed.
​
notes
string
Progress notes for the challenge. null if none were added.
​
created_at
string
required
ISO 8601 timestamp of when the record was created.
​
updated_at
string
required
ISO 8601 timestamp of this update.
Example response
{
  "id": 14,
  "user_id": "a3f2c1d0-89b4-4e7a-b6f5-1234567890ab",
  "template_id": 3,
  "status": "COMPLETED",
  "start_date": "2026-03-17T09:00:00.000Z",
  "completed_at": "2026-03-17T21:45:00.000Z",
  "notes": "Consegui manter o hábito todos os dias!",
  "created_at": "2026-03-17T09:00:00.000Z",
  "updated_at": "2026-03-17T21:45:00.000Z"
}

​
Errors

StatusDescription
401Missing, invalid, or expired token.
404No user challenge found with the given id.

Build docs developers (and LLMs) love

Get started for freeTalk to us