---
title: "ClaimNotificationPreferences"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/schemas/ClaimNotificationPreferences"
---

> Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md

# ClaimNotificationPreferences

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.9
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
components:
  schemas:
    ClaimNotificationMethod:
      type: object
      properties:
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        method:
          type: string
          enum:
            - MAIL
            - EMAIL
            - FAXNUMBER
          example: EMAIL
        faxOpted:
          type: boolean
          example: false
        emailOpted:
          type: boolean
          example: true
        mailOpted:
          type: boolean
          example: false
    ClaimFax:
      type: object
      properties:
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        faxNumber:
          type: string
          example: 973-555-0101
    ClaimEmail:
      type: object
      properties:
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        emailType:
          type: string
          example: PERSONAL
        emailAddress:
          type: string
          example: jane.smith@example.com
        emailId:
          type: string
          example: "1"
        isPreferred:
          type: boolean
          example: true
    ClaimAddress:
      type: object
      properties:
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        addressId:
          type: string
          example: "1"
        addressType:
          type: string
          example: RESIDENCE
        addressLine1:
          type: string
          example: 1112 Pickle Street
        addressLine2:
          type: string
          example: South Jersey
        addressLine3:
          type: string
          example: 1234 Post box
        city:
          type: string
          example: Garden City
        state:
          type: string
          example: NJ
        zipCode:
          type: string
          example: "67846"
        zipCodeExtension:
          type: string
          example: "23"
        country:
          type: string
          example: US
        correspondenceOnly:
          type: boolean
          description: When true, this address is used for correspondence/mailing only and
            is excluded from updates to the system of record.
          example: false
        isPreferred:
          type: boolean
          example: true
    ClaimPhone:
      type: object
      properties:
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        phoneType:
          type: string
          example: MOBILE
        countryCode:
          type: string
          example: "1"
        areaCode:
          type: string
          example: "973"
        dialNumber:
          type: string
          example: "7657890"
        extension:
          type: string
          nullable: true
        bestTime:
          type: string
          nullable: true
        timezone:
          type: string
          nullable: true
        phoneId:
          type: string
          example: "1"
        isPreferred:
          type: boolean
          example: true
    ClaimNotificationPreferences:
      type: object
      properties:
        notificationMethod:
          $ref: "#/components/schemas/ClaimNotificationMethod"
        fax:
          $ref: "#/components/schemas/ClaimFax"
        email:
          $ref: "#/components/schemas/ClaimEmail"
        address:
          $ref: "#/components/schemas/ClaimAddress"
        phone:
          $ref: "#/components/schemas/ClaimPhone"
```