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

# Edit Proxy User

> This endpoint allows a user to edit an existing Proxy User entry by providing the necessary `proxy_user_id`.

For access control, use the ProxyUserAcl endpoints to manage specific service or proxy access when using "service_restricted" or "proxy_restricted" access types.




## OpenAPI

````yaml patch /public/user/proxy_user/edit/{proxy_user_id}
openapi: 3.0.1
info:
  title: Byteful Public User API
  description: Public API used for third-party usage.
  termsOfService: https://byteful.com
  contact:
    url: https://byteful.com
    email: developer@byteful.com
  version: '1.0'
  x-logo:
    altText: Byteful
    backgroundColor: '#6354eb'
    url: >-
      https://pbs.twimg.com/profile_banners/1038803520605118464/1729783007/1500x500
servers:
  - url: https://api.byteful.com/1.0/
security: []
paths:
  /public/user/proxy_user/edit/{proxy_user_id}:
    patch:
      tags:
        - Proxy User
      summary: Edit Proxy User
      description: >
        This endpoint allows a user to edit an existing Proxy User entry by
        providing the necessary `proxy_user_id`.


        For access control, use the ProxyUserAcl endpoints to manage specific
        service or proxy access when using "service_restricted" or
        "proxy_restricted" access types.
      parameters:
        - name: proxy_user_id
          in: path
          description: ID of the proxy user record to edit.
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Content type for the request body as application/json.
          required: true
          schema:
            type: string
            default: application/json
      requestBody:
        description: The Proxy User details to be edited.
        content:
          application/json:
            schema:
              type: object
              properties:
                clear_proxy_user_acl:
                  type: boolean
                  description: >
                    When changing access_type, set to True to clear all existing
                    ProxyUserAcl entries.

                    Required when changing to "all" if ACLs exist. Optional for
                    other access_type changes.
                ip_address_authentications:
                  type: array
                  description: >-
                    A list of valid IP addresses authenticated for this Proxy
                    User.
                  example:
                    - 1.1.1.1
                    - 2.2.2.2
                  items:
                    type: string
                proxy_user_access_type:
                  type: string
                  description: >
                    Access control type for the proxy user:

                    - "all": Unrestricted access

                    - "service_restricted": Access restricted by ProxyUserAcl
                    service entries

                    - "proxy_restricted": Access restricted by ProxyUserAcl
                    proxy entries


                    **Note:** Default proxy users (proxy_user_is_default=true)
                    must always have access_type "all" and cannot be changed to
                    restricted access types.
                  enum:
                    - all
                    - service_restricted
                    - proxy_restricted
                proxy_user_enforce_https:
                  type: boolean
                  description: >-
                    If true, this Proxy User can only access targets on port 443
                    (HTTPS). This is useful for enforcing secure connections.
                  example: false
                proxy_user_is_strict_security:
                  type: boolean
                  description: Enable or disable strict security for the Proxy User.
                  example: false
                proxy_user_metadata:
                  type: object
                  properties: {}
                  description: |
                    Arbitrary metadata object associated with the Proxy User.
                    Constraints
                    - Supports string, boolean, float and integer values.
                    - Must be a non-nested JSON object.
                    - Maximum 30 keys.
                    - Each value's string representation ≤ 300 characters.
                    - Total size ≤ 32KB.
                  example:
                    internal_customer_id: 94266dc6-b29f-4499-a7a8-35232d186706
                proxy_user_mobile_bytes_limit:
                  type: integer
                  description: >-
                    The mobile bytes limit for the Proxy User (must be ≥ current
                    usage).
                  example: 1000000
                proxy_user_password:
                  type: string
                  description: >-
                    The new password for the Proxy User. Must be alphanumeric,
                    10 to 32 characters.
                  example: newPass1241233
                proxy_user_residential_bytes_limit:
                  type: integer
                  description: >-
                    The residential bytes limit for the Proxy User (must be ≥
                    current usage).
                  example: 1000000
        required: true
      responses:
        '200':
          description: Proxy User Successfully Edited
          content:
            application/json:
              schema:
                type: object
                properties:
                  edited:
                    type: array
                    description: List of Proxy User IDs that were successfully edited.
                    example:
                      - stevejobs
                    items:
                      type: string
                      description: The Proxy User ID.
                  message:
                    type: string
                    description: Success message indicating the Proxy User was edited.
                    example: Proxy User successfully edited.
                  proxy_user_acl_deleted:
                    type: array
                    description: >-
                      List of ProxyUserAcl IDs that were deleted during the edit
                      operation (when access_type is set to "all").
                    example:
                      - 123e4567-e89b-12d3-a456-426614174000
                    items:
                      type: string
                      description: The ProxyUserAcl ID.
      security:
        - APIPrivateKey: []
          APIPublicKey: []
components:
  securitySchemes:
    APIPrivateKey:
      type: apiKey
      description: ' Private API key for user-level authentication.'
      name: X-API-Private-Key
      in: header
    APIPublicKey:
      type: apiKey
      description: ' Public API key for user-level authentication.'
      name: X-API-Public-Key
      in: header

````