Sign in
journals

Update Journal

Update a journal's name, description, or other properties.

put/api/v1/journals/{journal_id}

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Path parameters

journal_idstring uuid required

Cookies

access_tokenstring nullable

Request body

titlestring nullable
descriptionstring nullable
color'#EF4444' | '#F97316' | '#F59E0B' | '#EAB308' | '#84CC16' | '#22C55E' | '#10B981' | '#14B8A6' | '#06B6D4' | '#0EA5E9' | '#3B82F6' | '#6366F1' | '#8B5CF6' | '#A855F7' | '#D946EF' | '#EC4899' | '#F43F5E' | '#64748B' | '#6B7280' | '#71717A' | '#737373' | '#78716C'

Preset colors for journals.

iconstring nullable
is_favoriteboolean nullable
is_archivedboolean nullable

Response

Successful Response

created_atstring date-time required
updated_atstring date-time required
titlestring required
descriptionstring nullable
color'#EF4444' | '#F97316' | '#F59E0B' | '#EAB308' | '#84CC16' | '#22C55E' | '#10B981' | '#14B8A6' | '#06B6D4' | '#0EA5E9' | '#3B82F6' | '#6366F1' | '#8B5CF6' | '#A855F7' | '#D946EF' | '#EC4899' | '#F43F5E' | '#64748B' | '#6B7280' | '#71717A' | '#737373' | '#78716C'

Preset colors for journals.

iconstring nullable
idstring uuid required
user_idstring uuid required
is_favoriteboolean required
is_archivedboolean required
positioninteger nullable
entry_countinteger required
total_wordsinteger required
last_entry_atstring date-time nullable

Changes

No recorded changes to this operation across all 9 revisions of this API.