{% extends "docs/base.html" %} {% block docs_content %}

Update timer

Update a timer's message, lifecycle status, or complete schedule.

{% include "docs/partials/timer-access.html" %}

Endpoints

PUT /api/v1/users/{username}/timers/{timer_uuid}
PUT /api/v1/teams/{team_slug}/timers/{timer_uuid}
PUT /api/v1/teams/{team_slug}/repos/{repo_slug}/timers/{timer_uuid}
PUT /api/v1/users/{username}/repos/{repo_slug}/timers/{timer_uuid}
Authenticated
{% with timer_schedule_optional = true %} {% include "docs/partials/timer-schedule-fields.html" %} {% endwith %}

Request

Omitted fields are preserved. Allowed requested statuses are active, paused, and cancelled; completed is set by the scheduler after a one-off fires.

{
  "message": "Review the updated release checklist",
  "status": "paused"
}

If any schedule field is supplied, it replaces the whole schedule:

{
  "run_in": "2h",
  "status": "active"
}

Reactivating a completed or cancelled timer requires a new schedule so it has a future run.

Success

200 OK with the updated timer JSON.

{% include "docs/partials/timer-api-object.html" %} {% endblock %}