Update the current user

OpenAPI contract

Method

PATCH

Path

/api/v1/user/me

Security

jwtBearer (bearer)

Response status

200 400 401 403 429 500

Request and response schemas

JSON

{
  "requestBody": {
    "application/json": {
      "$ref": "#/components/schemas/UpdateProfileRequest"
    }
  },
  "responses": {
    "200": {
      "description": "Account profile updated",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/UserResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

PATCH /api/v1/user/me is JWT-only. Any supplied profile fields are updated: displayName (max 80), locale (en, en-US, or equivalent two-letter language/region form; max 16), shareToExplore, defaultSharingPreferences (max 500), twoFactorEnabled, commentNotificationsEnabled, nonnegative creditCeiling, and nonblank workspaceName (max 100). The response is the updated profile.

An nfy_ automation key cannot update account settings. Blank optional text becomes unset except workspaceName, which cannot be blank when supplied. Validation errors are rejected.

http

PATCH /api/v1/user/me
Authorization: Bearer <access token>
Content-Type: application/json