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

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

# CommunicationPreference

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    CommunicationPreferenceCommunicationPreference:
      type: object
      properties:
        preferredCommunicationType:
          $ref: "#/components/schemas/PreferredCommunicationType"
        text:
          type: string
          example: OTHER
          description: If type OTHER, then provide further info using text.
    PreferredCommunicationType:
      type: string
      enum:
        - EMAIL
        - REGULARMAIL
        - PHONE
        - FAX
        - TEXT
        - NOPREFERENCESPECIFIED
        - POSTAL
        - OTHER
    CommunicationPreference:
      type: object
      properties:
        correlationId:
          type: string
          example: 657b717b7dcf554abf9ef067
          description: The unique ID to track transaction request across all systems
        effectiveDate:
          format: date
          type: string
          example: 2023-01-01
          description: Date (with pattern "yyyy-mm-dd")
        communicationPreference:
          $ref: "#/components/schemas/CommunicationPreferenceCommunicationPreference"
```