API ReferenceapiidentityPATCH /v1/users/me/settings

PATCH /v1/users/me/settings

Service: identity · operationId: (none)

Partial update of user settings (any subset of fields)

Required scopes

(no scope declared — review service config)

Request body

{
  "type": "object",
  "properties": {
    "profile_public": {
      "type": "boolean"
    },
    "show_full_name": {
      "type": "boolean"
    },
    "display_full_name": {
      "type": "boolean"
    },
    "specialties": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "maxItems": 20
    },
    "show_day_count": {
      "type": "boolean"
    },
    "notification_level": {
      "type": "string",
      "enum": [
        "all",
        "highlights",
        "off"
      ]
    },
    "timezone": {
      "type": "string"
    },
    "locale": {
      "type": "string"
    },
    "handle": {
      "type": "string",
      "minLength": 3,
      "maxLength": 20,
      "pattern": "^[a-z0-9_]+$"
    },
    "pronouns": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 50
    },
    "dose_reminder_schedule": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "morning_time": {
          "type": "string",
          "description": "HH:mm (24h)"
        },
        "evening_time": {
          "type": "string",
          "description": "HH:mm (24h)"
        },
        "days": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 6
          },
          "description": "0=Sun … 6=Sat"
        }
      },
      "required": [
        "morning_time",
        "evening_time",
        "days"
      ]
    }
  }
}

Responses

200 Updated settings

{
  "type": "object",
  "properties": {
    "profile_public": {
      "type": "boolean"
    },
    "show_full_name": {
      "type": "boolean"
    },
    "display_full_name": {
      "type": "boolean"
    },
    "specialties": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "show_day_count": {
      "type": "boolean"
    },
    "notification_level": {
      "type": "string",
      "description": "'all' | 'highlights' | 'off'"
    },
    "timezone": {
      "type": [
        "string",
        "null"
      ]
    },
    "locale": {
      "type": "string"
    },
    "handle": {
      "type": [
        "string",
        "null"
      ]
    },
    "pronouns": {
      "type": [
        "string",
        "null"
      ]
    },
    "dose_reminder_schedule": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "morning_time": {
          "type": "string",
          "description": "HH:mm (24h)"
        },
        "evening_time": {
          "type": "string",
          "description": "HH:mm (24h)"
        },
        "days": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 6
          },
          "description": "0=Sun … 6=Sat"
        }
      },
      "required": [
        "morning_time",
        "evening_time",
        "days"
      ]
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "profile_public",
    "show_full_name",
    "display_full_name",
    "specialties",
    "show_day_count",
    "notification_level",
    "timezone",
    "locale",
    "handle",
    "pronouns",
    "dose_reminder_schedule",
    "updated_at"
  ]
}

401 Not authenticated

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

500 Internal server error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X PATCH https://identity.platform.loop.health/v1/users/me/settings \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'