Update a focus record

Changed on

Updates the supplied fields of an existing focus record. type is required: use 0 for a Pomodoro record or 1 for a timing record. For Pomodoro records, taskId and status may also be updated. A supplied tasks array replaces the existing task associations.

post/open/v1/focus/{focusId}

Request

  • Base URL
    https://ticktick.com
  • Auth
    none declared

Path parameters

focusIdstring required

The ID of the focus record to update.

Request body

idstring

Focus record ID. It is supplied by the path when updating.

type0 | 1 required

Focus type: 0 for Pomodoro or 1 for timing.

taskIdstring

Task ID associated with a Pomodoro record.

notestring

Focus note. Blank notes are stored as null.

statusinteger

Pomodoro status.

startTimestring

Start time in "yyyy-MM-dd'T'HH:mm:ssZ" format.

endTimestring

End time in "yyyy-MM-dd'T'HH:mm:ssZ" format. It must not precede startTime.

pauseDurationinteger

Paused duration in seconds.

adjustTimeinteger

Manually adjusted duration in seconds.

addedboolean

Whether the focus record was manually added.

durationinteger

Focus duration in seconds.

createdTimestring

Creation time in "yyyy-MM-dd'T'HH:mm:ssZ" format.

modifiedTimestring

Last modification time in "yyyy-MM-dd'T'HH:mm:ssZ" format.

etagstring

Version identifier returned after a change.

Response

The updated focus record, or null when the record is not found.

idstring

Focus record ID. It is supplied by the path when updating.

type0 | 1 required

Focus type: 0 for Pomodoro or 1 for timing.

taskIdstring

Task ID associated with a Pomodoro record.

notestring

Focus note. Blank notes are stored as null.

statusinteger

Pomodoro status.

startTimestring

Start time in "yyyy-MM-dd'T'HH:mm:ssZ" format.

endTimestring

End time in "yyyy-MM-dd'T'HH:mm:ssZ" format. It must not precede startTime.

pauseDurationinteger

Paused duration in seconds.

adjustTimeinteger

Manually adjusted duration in seconds.

addedboolean

Whether the focus record was manually added.

durationinteger

Focus duration in seconds.

createdTimestring

Creation time in "yyyy-MM-dd'T'HH:mm:ssZ" format.

modifiedTimestring

Last modification time in "yyyy-MM-dd'T'HH:mm:ssZ" format.

etagstring

Version identifier returned after a change.

Changes