> ## Documentation Index
> Fetch the complete documentation index at: https://developers.factify.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update current user profile

> Updates the authenticated user's profile. Uses RFC 7396
(JSON Merge Patch) semantics: omitted fields are left
unchanged. `display_name` is required on every request and
cannot be cleared.

`given_name` and `family_name` accept `null` to clear. Empty
string is rejected with 422 — use `null`.

Email cannot be updated through this endpoint.




## OpenAPI

````yaml /openapi.json patch /v1/me
openapi: 3.1.0
info:
  title: Factify API
  version: 1.1.1
  description: >-
    Factify API enables organizations to ingest records, manage workflows, and
    extract auditable facts.


    ## Authentication


    Bearer authentication header of the form `Bearer <token>`, where `<token>`
    is your auth token.


    ```

    Authorization: Bearer ffy_prod_<base32_uuid><base62_random>

    ```


    ## Rate Limiting


    Per-API-key rate limits apply. Concrete thresholds are configured per

    deployment and surface via standard `Retry-After` and `RateLimit-*`

    response headers when a request is throttled.


    ## Errors


    Factify uses conventional HTTP status codes and returns structured error
    responses following [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457)
    (Problem Details for HTTP APIs).
  contact:
    name: Factify API Support
    email: api@factify.com
    url: https://factify.com/support
  license:
    name: Proprietary
    url: https://factify.com/terms
servers:
  - url: https://api.factify.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Organizations
    description: Organizations and their settings.
  - name: Members
    description: Membership roster and roles within an organization.
  - name: Invitations
    description: Pending invitations to join an organization.
  - name: Users
    description: The authenticated user's profile.
  - name: ApiKeys
    description: API keys used to authenticate SDK and integration callers.
  - name: Usage
    description: |
      Per-organization usage and quota limits. Future operations covering
      API-key-level quotas and usage history land here too.
  - name: Connections
    description: Inbound integration connections that records are ingested from.
  - name: Workflows
    description: Workflow templates that define the rubric set for fact extraction.
  - name: Plans
    description: Workflow instances — bind claims and lock to produce an extraction spec.
  - name: Records
    description: Generic JSON records ingested for claim extraction.
  - name: Audit
    description: Unified audit and provenance events.
  - name: Notifications
    description: In-app notification feed backed by audit events and per-user read state.
  - name: Internal
    description: Internal callbacks not intended for public SDK consumers.
  - name: RubricContentions
    description: >-
      Rubric contention detection and resolution — surface and resolve competing
      claim bindings.
  - name: IdentityProviders
    description: Per-organization SAML identity providers for SSO.
  - name: Analytics
    description: >-
      Org-scoped execution analytics — volume, decision breakdown, and latency
      over plan executions.
  - name: Auth
    description: |
      Browser-facing authentication surface — CSRF, session, OAuth callback,
      OTP, passkey, and refresh-token endpoints. These predate factapi's
      versioned `/v1/*` SDK surface and use the BetterAuth wire format the
      workspace SPA already speaks; SDK generators skip them via
      `x-speakeasy-ignore`.
paths:
  /v1/me:
    patch:
      tags:
        - Users
      summary: Update current user profile
      description: |
        Updates the authenticated user's profile. Uses RFC 7396
        (JSON Merge Patch) semantics: omitted fields are left
        unchanged. `display_name` is required on every request and
        cannot be cleared.

        `given_name` and `family_name` accept `null` to clear. Empty
        string is rejected with 422 — use `null`.

        Email cannot be updated through this endpoint.
      operationId: updateUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMeInputBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserOutputBody'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    UpdateMeInputBody:
      additionalProperties: false
      type: object
      description: |
        Request body for `PATCH /v1/me`. Optional nullable fields use
        RFC 7396 merge-patch semantics: omit to leave unchanged, send
        `null` to clear, send a value to set. `display_name` is
        required on every request and cannot be cleared.
      properties:
        display_name:
          type: string
          description: New display name. Required; empty string is rejected.
          minLength: 1
          maxLength: 255
          example: Alice Chen
        given_name:
          type: string
          nullable: true
          description: |
            New given (first) name. Send `null` to clear. Empty
            string is rejected — use `null`.
          minLength: 1
          maxLength: 128
          example: Alice
        family_name:
          type: string
          nullable: true
          description: |
            New family (last) name. Send `null` to clear. Empty
            string is rejected — use `null`.
          minLength: 1
          maxLength: 128
          example: Chen
      required:
        - display_name
    UserOutputBody:
      additionalProperties: false
      type: object
      description: >-
        Profile of the authenticated user. Returned by `GET /v1/me` and `PATCH
        /v1/me`.
      properties:
        id:
          type: string
          description: TypedID of the user.
          example: usr_01h2xcejqtf2nbrexx3vqjhp41
        email:
          type: string
          format: email
          description: User's email address.
          example: alice@factify.com
        display_name:
          type: string
          description: Display name shown in the UI. Always present.
          example: Alice Chen
        given_name:
          type: string
          nullable: true
          description: Given (first) name. Null when unknown.
          example: Alice
        family_name:
          type: string
          nullable: true
          description: Family (last) name. Null when unknown.
          example: Chen
      required:
        - id
        - email
        - display_name
    ErrorModel:
      additionalProperties: false
      type: object
      properties:
        detail:
          type: string
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          example: Property foo is required but is missing.
        errors:
          description: Optional list of individual error details
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
        instance:
          type: string
          format: uri
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          example: https://example.com/error-log/abc123
        status:
          type: integer
          format: int64
          description: HTTP status code
          example: 400
        title:
          type: string
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          example: Bad Request
        type:
          type: string
          format: uri
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          example: https://example.com/errors/example
    ErrorDetail:
      additionalProperties: false
      type: object
      properties:
        location:
          type: string
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
        message:
          type: string
          description: Error message text
        value:
          description: The value at the given location
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ErrorModel'
          example:
            type: about:blank
            title: Bad Request
            status: 400
            detail: Request body is malformed or missing required fields.
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ErrorModel'
          example:
            type: about:blank
            title: Unauthorized
            status: 401
            detail: Missing or invalid authentication credentials.
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ErrorModel'
          example:
            type: about:blank
            title: Forbidden
            status: 403
            detail: >-
              You do not have permission to perform this action on this
              resource.
    UnprocessableEntity:
      description: Unprocessable Entity
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ErrorModel'
          example:
            type: about:blank
            title: Unprocessable Entity
            status: 422
            detail: Request body failed validation.
            errors:
              - location: body.email
                message: expected string to match format 'email'
                value: not-an-email
    TooManyRequests:
      description: Too Many Requests
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ErrorModel'
          example:
            type: about:blank
            title: Too Many Requests
            status: 429
            detail: >-
              Rate limit exceeded. Retry after the period indicated by the
              Retry-After header.
    InternalServerError:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ErrorModel'
          example:
            type: about:blank
            title: Internal Server Error
            status: 500
            detail: >-
              An unexpected error occurred. Retry, and contact support if the
              issue persists.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |
        Bearer authentication using a factapi-issued API key
        (`ffy_<env>_<base32_uuid><base62_random>`). Cookie-based
        sessions are accepted automatically by user-facing endpoints
        but are not surfaced as an OpenAPI auth scheme.

````