> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hi-doctor.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Set your goal

> Full replace of the singleton goal. Read it first and merge, or omitted fields are cleared.



## OpenAPI

````yaml /api-reference/openapi.json put /v1/users/journal/goal/
openapi: 3.0.3
info:
  title: Hi-Doctor API
  version: 1.0.0
  description: >-
    Patient-facing REST API for Hi-Doctor.


    Authenticate with email and password to receive a JWT pair, then send the
    access token as `Authorization: Bearer <token>` on every subsequent request.


    Only patient-accessible endpoints are documented here. Clinician and
    back-office endpoints are intentionally omitted.
  contact:
    name: Hi-Doctor
    email: hello@hi-doctor.ai
    url: https://hi-doctor.ai
servers:
  - url: https://api.hi-doctor.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Registration, email verification, sign-in and profile.
  - name: Questionnaires
    description: Complete a consultation questionnaire and submit it for medical review.
  - name: Consultations
    description: Consultations a doctor has reviewed or is reviewing.
  - name: Prescriptions
    description: Prescriptions and reissue requests.
  - name: Billing
    description: Checkout, subscription management and the Stripe billing portal.
  - name: Records
    description: Orders, invoices and side-effect reports.
  - name: Messages
    description: The patient's private thread with their medical team.
  - name: Progress
    description: Weight, injection and note tracking. Requires an active treatment plan.
  - name: Referrals
    description: Referral summary and transactions.
paths:
  /v1/users/journal/goal/:
    put:
      tags:
        - Progress
      summary: Set your goal
      description: >-
        Full replace of the singleton goal. Read it first and merge, or omitted
        fields are cleared.
      operationId: users_journal_goal_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JournalGoal'
            example:
              target_weight_kg: 74
              starting_weight_kg: 86
              target_date: '2026-10-19'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalGoal'
              example:
                id: 0a1b2c3d-4e5f-4a6b-8c9d-000000000007
                created_at: '2026-08-02T06:57:53.527161Z'
                updated_at: '2026-08-02T11:43:49.840573Z'
                target_weight_kg: 74
                starting_weight_kg: 86
                target_date: '2026-10-19'
          description: ''
        '400':
          description: >-
            Validation failed. The body is an object keyed by field name, each
            value an array of messages.
          content:
            application/json:
              example:
                weight_kg:
                  - A valid number is required.
        '401':
          description: >-
            No bearer token, or a token that is expired or malformed.
            Re-authenticate; do not retry the same token.
          content:
            application/json:
              example:
                detail: Given token not valid for any token type
                code: token_not_valid
                messages:
                  - token_class: AccessToken
                    token_type: access
                    message: Token is invalid
      security:
        - jwtAuth: []
components:
  schemas:
    JournalGoal:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        target_weight_kg:
          type: number
          format: double
          maximum: 400
          minimum: 20
          nullable: true
        starting_weight_kg:
          type: number
          format: double
          maximum: 400
          minimum: 20
          nullable: true
        target_date:
          type: string
          format: date
          nullable: true
      required:
        - created_at
        - id
        - updated_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token from POST /v1/users/token/
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````