---
title: "UpdateAddressRequest"
url: "https://developer-staging.agentsync.io/apis/identity/versions/1ed33a2c-924a-434c-9643-fbc531dea1b8/schemas/UpdateAddressRequest"
---

> Full API specification: https://developer-staging.agentsync.io/apis/identity/versions/1ed33a2c-924a-434c-9643-fbc531dea1b8.md

# UpdateAddressRequest

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Identity API
  version: v1.275.8
servers:
  - url: https://api.sandbox.agentsync.io/id
    description: Sandbox server
  - url: https://api.agentsync.io/id
    description: Production server
components:
  schemas:
    AddressType:
      type: string
      enum:
        - MAILING
        - BUSINESS
        - PHYSICAL
      description: Type of address
    UpdateAddressRequest:
      title: UpdateAddressRequest
      type: object
      required:
        - type
        - addressLine1
        - city
        - state
        - zip
        - country
      properties:
        type:
          $ref: "#/components/schemas/AddressType"
        addressLine1:
          type: string
          description: First line of the street address.
          example: 123 Main St
        addressLine2:
          type: string
          nullable: true
          description: Second line of the street address (suite, unit, etc.).
          example: Apt 4B
        city:
          type: string
          description: City.
          example: Denver
        state:
          type: string
          description: Two-letter US state code.
          example: CO
        zip:
          type: string
          pattern: ^\d{5}(-\d{4})?$
          description: ZIP code in 5-digit or ZIP+4 format.
          example: "80202"
        county:
          type: string
          nullable: true
          description: County name.
          example: Denver
        country:
          type: string
          description: Country code (ISO alpha-2).
          example: US
        moveInDate:
          type: string
          format: date
          nullable: true
          description: Date the person moved to this address (YYYY-MM-DD).
          example: 2020-01-15
        preferred:
          type: boolean
          nullable: true
          default: false
          description: >
            Whether this should be the preferred address. When true, any other
            preferred address for the same person or firm is automatically
            unset. Omitting or null is treated as false.
          example: false
```