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

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

# CommunicationPreferenceChangeRequest

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.8
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
components:
  schemas:
    CommunicationPreferenceChange:
      type: object
      properties:
        correlationId:
          type: string
          format: uuid
          example: 142f6328-0b47-412d-a1db-375e8cb81cb7
          description: The unique ID to track transaction request across all systems
        effectiveDate:
          type: string
          format: date
          pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
          example: 2022-01-01
          description: Date (with pattern "yyyy-mm-dd")
        communicationPreference:
          type: object
          properties:
            preferredCommunicationType:
              type: string
              enum:
                - EMAIL
                - FAX
                - NOPREFERENCE
                - OTHER
                - PHONE
                - REGULARMAIL
                - TEXT
              description: Communication Preference Type
              example: EMAIL
            text:
              type: string
              example: in-person meetings or video call id https://company.us/j/1234567890
              description: If type OTHER, then provide further info using text.
          required:
            - preferredCommunicationType
      required:
        - effectiveDate
        - communicationPreference
    CommunicationPreferenceChangeRequest:
      type: object
      allOf:
        - $ref: "#/components/schemas/CommunicationPreferenceChange"
      properties:
        caseId:
          type: string
          example: CA0000007389
          description: Zinnia Live Case ID
```