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

# Update Payee Address

> Update an existing address associated with a payee.

This endpoint allows you to:
- Modify billing or location details
- Correct street, city, state, or ZIP code
- Keep records aligned with compliance requirements
- Update default designation if needed
- Maintain accurate location data for Paywint services



## OpenAPI

````yaml PATCH /api/user-api/address/payee/update
openapi: 3.1.0
info:
  title: paywint
  version: 0.1.0
servers:
  - url: https://api.sandbox.paywint.com
  - url: https://api.paywint.com
security: []
paths:
  /api/user-api/address/payee/update:
    patch:
      tags:
        - Developer API Address
      summary: Update Payee Address
      description: |-
        Update an existing address associated with a payee.

        This endpoint allows you to:
        - Modify billing or location details
        - Correct street, city, state, or ZIP code
        - Keep records aligned with compliance requirements
        - Update default designation if needed
        - Maintain accurate location data for Paywint services
      operationId: update_payee_address_api_user_api_address_payee_update_patch
      parameters:
        - name: X-Api-Key
          in: header
          required: true
          schema:
            type: string
            description: >-
              Your API Key (UUID format). Required to identify and authorize
              each request
            title: X-Api-Key
          description: >-
            Your API Key (UUID format). Required to identify and authorize each
            request
        - name: X-Api-Secret
          in: header
          required: true
          schema:
            type: string
            description: >-
              Secret associated with your API Key. Used for authenticating
              requests. Keep this secure.
            title: X-Api-Secret
          description: >-
            Secret associated with your API Key. Used for authenticating
            requests. Keep this secure.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserApiContactAddressUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CommonResponse_ExternalContactAddressRead_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UserApiContactAddressUpdate:
      properties:
        payee_id:
          type: string
          format: uuid4
          title: Payee Id
          description: Unique identifier for the payee whose addresses are being managed.
          example: f47ac10b-****-****-****-0e02b2c3d479
        address_id:
          type: string
          format: uuid4
          title: Address Id
          description: Unique identifier for the payee address record.
          example: 2d8c5ca1-98cb-42f7-8c1e-70a2b0b8e8f1
        first_name:
          anyOf:
            - type: string
              maxLength: 100
              minLength: 2
            - type: 'null'
          title: First Name
          description: Recipient's first name for the updated address (optional).
        last_name:
          anyOf:
            - type: string
              maxLength: 100
              minLength: 1
            - type: 'null'
          title: Last Name
          description: Last name for the updated address (optional).
        address_line_1:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Address Line 1
          description: Primary street line for the updated address (optional).
        address_line_2:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Address Line 2
          description: Secondary street line (optional).
        company_name:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Company Name
          description: Optional company name for the address.
        city:
          anyOf:
            - type: string
              maxLength: 40
            - type: 'null'
          title: City
          description: City for the updated address (optional).
        state:
          anyOf:
            - type: string
              maxLength: 30
            - type: 'null'
          title: State
          description: State or province (optional).
        zipcode:
          anyOf:
            - type: string
              maxLength: 10
            - type: 'null'
          title: Zipcode
          description: Postal code (optional).
        country:
          anyOf:
            - type: string
              maxLength: 40
            - type: 'null'
          title: Country
          description: Country name (optional).
        is_default:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Default
          description: >-
            If true, makes this address the default; false leaves the default
            untouched.
      type: object
      required:
        - payee_id
        - address_id
      title: UserApiContactAddressUpdate
    CommonResponse_ExternalContactAddressRead_:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was processed successfully.
          default: true
          example: true
        message:
          type: string
          title: Message
          description: >-
            A short, human-readable message describing the result of the
            request.
          default: Success
          example: Operation completed.
        data:
          anyOf:
            - $ref: '#/components/schemas/ExternalContactAddressRead'
            - type: 'null'
          description: The main response payload, if applicable
        queryGeneratedTime:
          anyOf:
            - type: number
            - type: 'null'
          title: Querygeneratedtime
          description: >-
            The Unix timestamp (in seconds) indicating when the response was
            generated.
          default: 1778161546.973489
          example: 1718006400
      type: object
      title: CommonResponse[ExternalContactAddressRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ExternalContactAddressRead:
      properties:
        address_id:
          type: string
          format: uuid4
          title: Address Id
          description: Unique identifier (UUID) for this address record.
          example: a1b2c3d4-****-****-****-e5f6g7h8i9j0
        fist_name:
          type: string
          maxLength: 100
          minLength: 2
          title: Fist Name
          description: Recipient's first name.
          example: John
        last_name:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Last Name
          description: Recipient's last name (optional).
          example: Doe
        address_line_1:
          type: string
          maxLength: 100
          title: Address Line 1
          description: Street address including apartment, suite, or unit number.
          example: 123 Main Street, Apt 4B
        address_line_2:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Address Line 2
          description: Street address including apartment, suite, or unit number.
          example: 123 Main Street, Apt 4B
        company_name:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Company Name
          description: Full name of the payee's company.
          example: Meta Corp
        city:
          type: string
          maxLength: 40
          title: City
          description: City name.
          example: New York
        state:
          type: string
          maxLength: 30
          title: State
          description: State, province, or region.
          example: NY
        zipcode:
          type: string
          maxLength: 10
          title: Zipcode
          description: Postal code or ZIP code.
          example: '10001'
        country:
          type: string
          maxLength: 40
          title: Country
          description: Country name.
          example: United States
        is_default:
          type: boolean
          title: Is Default
          description: Mark this address as the default payee address.
          default: false
        created_at:
          type: string
          format: date-time
          title: Created At
          description: ISO 8601 timestamp indicating when this address record was created.
          example: '2024-01-15T10:30:00Z'
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
          description: ISO 8601 timestamp indicating when this address record was updated.
          example: '2024-01-15T10:30:00Z'
      type: object
      title: ExternalContactAddressRead
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````