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

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

# EmailChangeRequest

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    EmailBase:
      type: object
      properties:
        startDate:
          type: string
          description: The start date of when the party can be reached via email.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 email. Date (with
            pattern "yyyy-mm-dd")
          example: 2023-01-01
          format: date
        emailType:
          $ref: "#/components/schemas/EmailType"
        emailAddress:
          type: string
          description: Email address of the party
          example: user@example.com
        isPreferred:
          type: boolean
          description: The Preferred Email Indicator is a boolean flag associated with
            each email address linked to a party, used to designate which email
            address should be treated as the primary contact for electronic
            communications
    EmailType:
      type: string
      enum:
        - PERSONAL
        - BUSINESS
        - CUSTOMERSERVICE
        - OTHER
    EmailChangeRequest:
      type: object
      properties:
        correlationId:
          type: string
          example: 657b717b7dcf554abf9ef067
          description: The unique ID to track transaction request across all systems
        isPreferredEmail:
          type: string
          description: This field is deprecated and will be removed in a future version.
            Please use email.isPreferred instead.
          enum:
            - YES
            - NO
          deprecated: true
        preferredEmailId:
          type: string
          description: The Preferred Email ID refers to the unique identifier of the email
            address designated as the primary or preferred email contact for an
            individual or entity when multiple email addresses are on file.
          example: "1"
        effectiveDate:
          type: string
          example: 2023-01-01
          description: Date (with pattern "yyyy-mm-dd")
          format: date
        email:
          $ref: "#/components/schemas/EmailBase"
```