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

# Update the current user profile (Beta)

> Update the authenticated user's profile using top-level JSON fields. Returns the updated profile.

**Beta:** this API should be considered a beta integration target because it may change if user account settings require changes



## OpenAPI

````yaml /openapi/source/external/user-profile/user-profile.json patch /user_profile
openapi: 3.1.0
info:
  title: Telnyx User Profile API
  version: 2.0.0
  x-latency-category: responsive
  x-endpoint-cost: light
  description: Retrieve and update the authenticated user's account profile (Beta).
  contact:
    email: support@telnyx.com
servers:
  - url: https://api.telnyx.com/v2
security:
  - bearerAuth: []
tags:
  - name: User Profile
    description: Read and update the authenticated user's profile and data locality.
paths:
  /user_profile:
    patch:
      tags:
        - User Profile
      summary: Update the current user profile (Beta)
      description: >-
        Update the authenticated user's profile using top-level JSON fields.
        Returns the updated profile.


        **Beta:** this API should be considered a beta integration target
        because it may change if user account settings require changes
      operationId: UpdateUserProfile
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserProfileRequest'
      responses:
        '200':
          description: The updated user profile.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/UserProfile'
              example:
                data:
                  record_type: user_profile
                  id: 12345
                  user_id: 12ade33a-21c0-473b-b055-b3c836e1c292
                  updated_at: '2026-01-15T10:30:00Z'
                  first_name: Alex
                  last_name: Taylor
                  business_name: Example Company
                  data_locality: UAE
                  data_locality_updated_at: '2026-01-15T10:00:00Z'
                  data_locality_migration_status: finished
        '401':
          description: >-
            Authentication failed. Supply a valid API key using Bearer
            authentication.
        '403':
          description: The authenticated user is not permitted to access this resource.
        '422':
          description: >-
            Validation failed, such as an invalid field value, an invalid
            address, a disallowed data-locality change, or an organization
            sub-user attempting to change low-balance notification frequency.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: API error code.
                        title:
                          type: string
                          description: Error title.
                        detail:
                          type: string
                          description: Explanation of the error.
                        source:
                          type: object
                          properties:
                            pointer:
                              type: string
                              description: Pointer to the invalid field.
                        meta:
                          type: object
                          additionalProperties: true
                          description: Additional error metadata.
              example:
                errors:
                  - code: '10027'
                    title: Unprocessable Entity
                    detail: is not an acceptable value
                    source:
                      pointer: /data_locality
                    meta:
                      url: https://developers.telnyx.com/docs/overview/errors/10027
components:
  schemas:
    UpdateUserProfileRequest:
      type: object
      description: Profile fields to update. Omitted fields retain their current values.
      properties:
        first_name:
          type:
            - string
            - 'null'
          description: The user's first name.
          example: Alex
          maxLength: 100
        last_name:
          type:
            - string
            - 'null'
          description: The user's last name.
          example: Taylor
          maxLength: 100
        business_name:
          type:
            - string
            - 'null'
          description: Business name associated with the profile.
          example: Example Company
          maxLength: 255
        phone_number:
          type:
            - string
            - 'null'
          description: Contact phone number associated with the profile.
          example: '+13125550100'
        address_1:
          type:
            - string
            - 'null'
          description: First line of the profile address.
          example: 123 Example Street
        address_2:
          type:
            - string
            - 'null'
          description: Second line of the profile address.
          example: Suite 100
        city:
          type:
            - string
            - 'null'
          description: City in the profile address.
          example: Chicago
        state:
          type:
            - string
            - 'null'
          description: State or region in the profile address.
          example: IL
        zip:
          type:
            - string
            - 'null'
          description: Postal code in the profile address.
          example: '60601'
        country:
          type:
            - string
            - 'null'
          description: Country code in the profile address.
          example: US
        got_free_number_at_signup:
          type: boolean
          description: Whether the user received a free number at signup.
          example: false
        ui_theme:
          type: integer
          description: 'User interface theme: 0 for dark or 1 for light.'
          example: 1
          enum:
            - 0
            - 1
        low_balance_threshold_amount:
          type:
            - number
            - 'null'
          description: >-
            Low-balance notification threshold in the billing currency. The
            resulting profile must have both a threshold and notification
            frequency, or neither.
          example: 10
        low_balance_notification_frequency:
          type:
            - integer
            - 'null'
          description: >-
            Low-balance notification frequency. Organization sub-users cannot
            set a non-null frequency. The resulting profile must have both a
            threshold and frequency, or neither.
          example: 12
          enum:
            - 2
            - 4
            - 12
            - 24
            - null
        notify_on_invoice_available:
          type: boolean
          description: Whether to notify the user when an invoice is available.
          example: true
        notify_on_invoice_payment:
          type: boolean
          description: Whether to notify the user when an invoice is paid.
          example: false
        primary_use_case:
          type: string
          description: Primary use case for the account.
          example: configure sip trunks
        default_numbers_external_pin:
          type: string
          description: Default alphanumeric external PIN for phone numbers.
          example: '1234'
          minLength: 4
          maxLength: 16
        role:
          type: string
          description: The user's role.
          example: account manager
        company_size:
          type: string
          description: Company size reported by the user.
          example: 11-50
        npac_user:
          type: boolean
          description: Whether the user is an NPAC user.
          example: false
        user_subscription_opt_in:
          type: boolean
          description: Whether the user opts in to subscriptions.
          example: false
        default_managed_account_allow_custom_pricing:
          type: boolean
          description: Default custom-pricing setting for managed accounts.
          example: false
        default_managed_account_rollup_billing:
          type: boolean
          description: Default rollup-billing setting for managed accounts.
          example: false
        default_notify_manager_account:
          type: boolean
          description: Default setting for notifying the manager account.
          example: true
        port_out_pin_validation:
          type: boolean
          description: Whether port-out PIN validation is enabled.
          example: false
        default_managed_account_inherit_emergency_terms_of_service:
          type: boolean
          description: >-
            Default emergency terms-of-service inheritance setting for managed
            accounts, where supported.
          example: false
        data_locality:
          type: string
          enum:
            - USA
            - DEU
            - AUS
            - UAE
            - CAN
          description: >-
            Data locality: USA (United States), DEU (Germany), AUS (Australia),
            UAE (United Arab Emirates), or CAN (Canada). A change is permitted
            only if data locality has not previously been changed. A successful
            change sets data_locality_updated_at and initializes
            data_locality_migration_status to not_started.
          example: DEU
        use_cases:
          type: array
          description: Use cases reported by the user.
          items:
            type: string
          example:
            - voice
        onboarding_use_cases_other:
          type: array
          description: Other onboarding use cases.
          items:
            type: string
          example:
            - customer support
        onboarding_project_types:
          type: array
          description: Onboarding project types.
          items:
            type: string
          example:
            - contact center
        onboarding_reasons_for_consideration:
          type: array
          description: Reasons for considering Telnyx.
          items:
            type: string
          example:
            - API integration
        onboarding_industries:
          type: array
          description: Industries reported during onboarding.
          items:
            type: string
          example:
            - software
        onboarding_monthly_budget:
          type: array
          description: Monthly budget ranges reported during onboarding.
          items:
            type: string
          example:
            - 1000-5000
        onboarding_referrer:
          type: array
          description: Referral sources reported during onboarding.
          items:
            type: string
          example:
            - search engine
        onboarding_build_method:
          type: array
          description: Build methods reported during onboarding.
          items:
            type: string
          example:
            - API
        onboarding_product_interest:
          type: array
          description: Products of interest reported during onboarding.
          items:
            type: string
            maxLength: 255
          example:
            - voice
          maxItems: 20
      example:
        first_name: Alex
        last_name: Taylor
        ui_theme: 1
    UserProfile:
      type: object
      description: The authenticated user's profile.
      additionalProperties: true
      properties:
        record_type:
          type: string
          enum:
            - user_profile
          description: Identifies the type of resource.
          example: user_profile
        id:
          type: integer
          description: Identifier of the user profile, distinct from the user ID.
          example: 12345
        user_id:
          type: string
          description: Identifier of the user who owns this profile.
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
        updated_at:
          type: string
          format: date-time
          description: Timestamp of the most recent profile update.
          example: '2026-01-15T10:30:00Z'
        first_name:
          type:
            - string
            - 'null'
          description: The user's first name.
          example: Alex
        last_name:
          type:
            - string
            - 'null'
          description: The user's last name.
          example: Taylor
        business_name:
          type:
            - string
            - 'null'
          description: Business name associated with the profile.
          example: Example Company
        phone_number:
          type:
            - string
            - 'null'
          description: Contact phone number associated with the profile.
          example: '+13125550100'
        address_1:
          type:
            - string
            - 'null'
          description: First line of the profile address.
          example: 123 Example Street
        address_2:
          type:
            - string
            - 'null'
          description: Second line of the profile address.
          example: Suite 100
        city:
          type:
            - string
            - 'null'
          description: City in the profile address.
          example: Chicago
        state:
          type:
            - string
            - 'null'
          description: State or region in the profile address.
          example: IL
        zip:
          type:
            - string
            - 'null'
          description: Postal code in the profile address.
          example: '60601'
        country:
          type:
            - string
            - 'null'
          description: Country code in the profile address.
          example: US
        data_locality:
          type:
            - string
            - 'null'
          enum:
            - USA
            - DEU
            - AUS
            - UAE
            - CAN
            - null
          description: >-
            The user's data locality: USA (United States), DEU (Germany), AUS
            (Australia), UAE (United Arab Emirates), or CAN (Canada).
          example: UAE
        data_locality_updated_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Timestamp when the user's data locality was last changed, or null if
            it has not been changed.
          example: '2026-01-15T10:00:00Z'
        data_locality_migration_status:
          type:
            - string
            - 'null'
          enum:
            - not_started
            - in_progress
            - finished
            - null
          description: >-
            Status of the user's data locality migration, or null when no
            migration status is recorded.
          example: finished
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````