---
title: "PhoneChangeRequest"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/PhoneChangeRequest"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# PhoneChangeRequest

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://uat.api.zinnia.io
components:
  schemas:
    PhoneBase:
      type: object
      properties:
        startDate:
          type: string
          description: The start date of when the party can be reached via the phone.Date
            (with pattern "yyyy-mm-dd")
          example: 2023-01-01
          format: date
        endDate:
          type: string
          description: The end date of when the party can be reached via the phone. Date
            (with pattern "yyyy-mm-dd")
          example: 2023-01-01
          format: date
        phoneType:
          $ref: "#/components/schemas/PhoneType"
        countryCode:
          type: string
          description: Country Code of the phone
          example: "9"
        areaCode:
          type: string
          description: Area code of the phone
          example: "973"
        dialNumber:
          type: string
          description: Dial number of the phone
          example: "765789"
        extension:
          type: string
          description: Dial in Extension for phone
          example: "null"
        bestTime:
          type: string
          description: The best time to contact the party via phone
          example: "null"
        timezone:
          type: string
          description: Timezone for the entered phone details
          example: "null"
        isPreferred:
          type: boolean
          description: The Preferred Phone Indicator is a boolean flag or attribute
            assigned to each phone number associated with a party, used to
            identify which phone number should be used as the primary contact
            number for communication
    PhoneType:
      type: string
      enum:
        - MOBILE
        - HOME
        - BUSINESS
        - CLAIMCENTER
        - CUSTOMERSERVICE
        - CORPORATEOFFICE
        - FAX
        - UNKNOWN
        - OTHER
    PhoneChangeRequest:
      type: object
      properties:
        correlationId:
          type: string
          example: 657b717b7dcf554abf9ef067
          description: The unique ID to track transaction request across all systems
        isPreferredPhone:
          type: string
          description: This field is deprecated and will be removed in a future version.
            Please use phone.isPreferred instead.
          enum:
            - YES
            - NO
        preferredPhoneId:
          type: string
          description: The Preferred Phone ID refers to the unique identifier of the phone
            number designated as the primary contact number for a given
            individual or entity when multiple phone numbers are associated with
            the same party
          example: "1"
        effectiveDate:
          type: string
          example: 2023-01-01
          description: Date (with pattern "yyyy-mm-dd")
          format: date
        phone:
          $ref: "#/components/schemas/PhoneBase"
```