---
title: "Update Initial Death Claim Notification Method"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/operations/updateNotificationMethod1"
---

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

# Update Initial Death Claim Notification Method

`PUT` `/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/initialdeathclaim/notificationmethod`

Operation ID: `updateNotificationMethod1`

Updates the notification method (and related beneficiary/change details) for a party on an initial death claim case.

## Path parameters

- `planCode` (string, required) - Plan Code
- `policyNumber` (string, required) - Policy Number
- `partyId` (string, required) - Identifier of the party whose notification method is being updated

## Request body (required)

Content types: `application/json`

## Responses

- `202` - Update Notification Method Transaction Accepted
- `400` - Invalid request body. One or more fields failed validation.
- `500` - Internal server error. Please check server logs for more details.

## 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
paths:
  /policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/initialdeathclaim/notificationmethod:
    put:
      x-kong-plugin-pre-function:
        config:
          access:
            - >
              local path = kong.request.get_path()

              local new_path = path:gsub("^/policy/v1/transactions",
              "/bpm/v1/policies")

              kong.service.request.set_path(new_path)
      tags:
        - Non Financial Transactions
      summary: Update Initial Death Claim Notification Method
      description: Updates the notification method (and related beneficiary/change
        details) for a party on an initial death claim case.
      operationId: updateNotificationMethod1
      parameters:
        - name: planCode
          in: path
          required: true
          schema:
            type: string
          description: Plan Code
          example: EVIU101
        - name: policyNumber
          in: path
          required: true
          schema:
            type: string
          description: Policy Number
          example: EVIUL7RED022
        - name: partyId
          in: path
          required: true
          schema:
            type: string
          description: Identifier of the party whose notification method is being updated
          example: e6954b3d-a0ef-47dc-ac49-046db6bc7da7
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/IdnNotificationMethodUpdate"
      responses:
        "202":
          description: Update Notification Method Transaction Accepted
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionAcceptedResponse"
        "400":
          description: Invalid request body. One or more fields failed validation.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionResponse"
              examples:
                failure:
                  $ref: "#/components/examples/failureTransactionResponse"
        "500":
          description: Internal server error. Please check server logs for more details.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionResponse"
      security:
        - Auth0: []
security:
  - Auth0: []
components:
  schemas:
    IdnNotificationMethodUpdate:
      type: object
      description: Internal payload used to update the notification method (and
        related beneficiary/change details) for a party on an initial death
        claim case.
      properties:
        zlCaseId:
          type: string
          example: ZL-CA0000369469
        businessKey:
          type: string
          example: CA0000369469
        correlationid:
          type: string
          example: 3a2a3435-2089-4b81-9959-e0d569ccf4f0
        sorSystem:
          type: string
          example: LIFECAD
        sourceSystem:
          type: string
          example: ZAHARA
        carrierId:
          type: string
          example: OTP_DC
        planCode:
          type: string
          example: EVIU101
        policyNumber:
          type: string
          example: EVIUL7RED022
        updateDate:
          type: string
          format: date
          example: 2026-10-12
          description: Date (with pattern "yyyy-mm-dd")
        beneficiaryRecordId:
          type: string
          example: BEN-10045
        beneficiary:
          $ref: "#/components/schemas/ClaimParty"
        beneficiaryChangeDetail:
          $ref: "#/components/schemas/ClaimBeneChangeDetail"
        contactEstablished:
          type: boolean
          example: true
        taskActions:
          type: array
          items:
            type: string
            enum:
              - RESEND_PACKET
              - CONTACT_ESTABLISHED
              - UPDATE_NOTIFICATION_METHOD
          example:
            - UPDATE_NOTIFICATION_METHOD
    TransactionAcceptedResponse:
      type: object
      properties:
        correlationId:
          type: string
          example: 3a2a3435-2089-4b81-9959-e0d569ccf4f0
          description: Unique identifier which used by every system to trace the request
        caseId:
          type: string
          example: CA0000369469
          description: Zinnia Live Case ID
        caseStatus:
          type: string
          example: IN_PROGRESS
          description: Zinnia Live Case Status
        pdfId:
          type: string
          description: Identifier for the generated or associated PDF document (e.g.
            OnBase document number). Returned on systematic program setup and
            update submit when available.
          example: DOC-10004567
    TransactionResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
            - failure
        error:
          type: array
          items:
            $ref: "#/components/schemas/Error"
        quoteResponse:
          type: object
    ClaimParty:
      type: object
      description: Beneficiary/party details used internally by notification-method
        update processing.
      properties:
        partyId:
          type: string
          example: e6954b3d-a0ef-47dc-ac49-046db6bc7da7
        partyRoleId:
          type: string
          example: PR-10045
        partyRole:
          type: string
          example: PRIMARYBENEFICIARY
        partyType:
          type: string
          example: INDIVIDUAL
        trustType:
          type: string
          example: INTERVIVOSTRUST
        prefix:
          type: string
          example: Ms.
        suffix:
          type: string
          example: Jr.
        firstName:
          type: string
          example: Jane
        middleName:
          type: string
          example: Marie
        lastName:
          type: string
          example: Smith
        fullName:
          type: string
          example: Jane Marie Smith
        gender:
          type: string
          example: FEMALE
        dateOfBirth:
          type: string
          format: date
          example: 1990-01-01
          description: Date (with pattern "yyyy-mm-dd")
        dateOfDeath:
          type: string
          format: date
          nullable: true
          description: Date (with pattern "yyyy-mm-dd")
        relationshipToInsured:
          type: string
          example: SPOUSE
        relationshipToParty:
          type: string
          example: SPOUSE
        beneficiaryPartyType:
          type: string
          example: PRIMARY
        beneficiaryPercentage:
          type: number
          format: double
          example: 50
        beneficiaryNetDeathBenefit:
          type: number
          format: double
          example: 100000
        beneficiaryState:
          type: string
          example: NJ
        residenceState:
          type: string
          example: NJ
        ssn:
          type: string
          example: 123-45-6789
        phone:
          $ref: "#/components/schemas/ClaimPhone"
        agentExternalId:
          type: string
          example: AGT10001
        taxIdentifierType:
          type: string
          example: SSN
        sorDistributionMethod:
          $ref: "#/components/schemas/DistributionMethod"
        formDistributionMethod:
          $ref: "#/components/schemas/DistributionMethod"
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        residentAddress:
          $ref: "#/components/schemas/ClaimFormAddress"
        identifiers:
          type: array
          items:
            $ref: "#/components/schemas/PartyIdentifier"
        organizationCode:
          type: string
          example: ORG-10045
        entityType:
          type: string
          example: CORPORATION
        trustTitle:
          type: string
          example: Trustee
        trustDate:
          type: string
          format: date
          example: 2025-12-15
          description: Date (with pattern "yyyy-mm-dd")
        trustName:
          type: string
          example: The Smith Family Trust
        governingStateOfTrust:
          type: string
          example: NJ
        enityType:
          type: string
          enum:
            - SOLEPROPRIETORSHIP
            - GENERALPARTNERSHIP
            - LIMITEDPARTNERSHIP
            - CCORPORATION
            - SCORPORATION
            - LIMITEDLIABILITYCOMPANY
            - CHARITABLEORGANIZATION
            - ESTATE
            - TRUST
            - CORPORATION
            - INSURANCECOMPANY
            - UNKNOWN
          description: Mirrors the "entityType" field above; retained for backward
            compatibility with the source model.
          example: CORPORATION
    ClaimBeneChangeDetail:
      type: object
      properties:
        changeRequire:
          type: boolean
          example: true
        changeType:
          type: string
          enum:
            - BENEFICIARY_DECEASED
            - BENEFICIARY_NOTIFICATION_CHANGE
            - BENEFICIARY_ADDRESS_CHANGE
          example: BENEFICIARY_NOTIFICATION_CHANGE
        beneDeceased:
          type: boolean
          example: false
        beneDeathDate:
          type: string
          format: date
          nullable: true
          description: Date (with pattern "yyyy-mm-dd")
        beneDeathSourceOfInfo:
          type: string
          example: Death Master File
        notificationPreferences:
          $ref: "#/components/schemas/ClaimNotificationPreferences"
        documentData:
          type: array
          description: Document metadata associated with this change
          items:
            $ref: "#/components/schemas/ClaimDocumentMetadata"
    Error:
      type: object
      properties:
        errorCode:
          type: string
          example: BPM.NM.002
          description: This is the NIGO id generated by BPM system
        attribute:
          type: string
        error:
          type: string
          description: This is the error generated by BPM system
        resolution:
          type: string
          description: Resolution generated by BPM system to resolve the error
    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
    DistributionMethod:
      type: object
      properties:
        distributionMethodOption:
          type: string
          enum:
            - US_MAIL
            - DIRECT_DEPOSIT
            - BROKERAGE_ACCOUNT
            - EFT
            - WIRE
            - MANUAL_CHECK
            - EXPRESS_CHECK
            - CHECK
            - ACH
            - EXCHANGE
            - PREMIUMLOAN
            - CREDITCARD
            - DTCC
          example: DIRECT_DEPOSIT
        bankDetails:
          type: array
          items:
            $ref: "#/components/schemas/BankDetails"
        manualCheckAddress:
          type: boolean
          example: false
        isBankConfirmationLetterAvailable:
          type: boolean
          example: false
        isVoidCheckAvailable:
          type: boolean
          example: false
        isValidSecurityRequirements:
          type: boolean
          example: true
        mailingAddress:
          $ref: "#/components/schemas/ClaimFormAddress"
        usMailOption:
          type: string
          enum:
            - MAIL_CHECKS_TO_THE_OWNERS_ADDRESS_OF_RECORD
            - MAIL_CHECKS_TO_THE_ADDRESS_LISTED_BELOW
        dtccDetails:
          $ref: "#/components/schemas/ClaimDtccDetails"
    ClaimFormAddress:
      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
        isPreferred:
          type: boolean
          example: true
    PartyIdentifier:
      type: object
      properties:
        type:
          type: string
          enum:
            - SSN
            - EIN
            - TIN
        value:
          type: string
          example: 123-45-6789
        description:
          type: string
          example: Social Security Number
        source:
          type: string
          example: SSA
        issueDate:
          type: string
          format: date
          example: 2015-01-01
          description: Date (with pattern "yyyy-mm-dd")
        expirationDate:
          type: string
          format: date
          nullable: true
          example: 2070-01-01
          description: Date (with pattern "yyyy-mm-dd")
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          example: ACTIVE
        countryOfIssue:
          type: string
          example: US
    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"
    ClaimDocumentMetadata:
      type: object
      properties:
        displayName:
          type: string
          example: Certified Death Certificate
        documentSource:
          type: string
          example: OnBase
        documentName:
          type: string
          example: Certified Death Certificate - John Smith
        documentNumber:
          type: string
          example: DOC-10004567
        timeStamp:
          type: string
          example: 2026-10-12T10:15:30Z
        subCategory:
          type: string
          example: Death Certificate
        documentCategory:
          type: string
          example: Claim
        docClassification:
          type: string
          example: CONFIDENTIAL
        documentExt:
          type: string
          example: pdf
        documentId:
          type: string
          example: EDS-DOC-987654321
        documentType:
          type: string
          example: DEATH_CERTIFICATE
        docAccessLevel:
          type: string
          example: INTERNAL
    BankDetails:
      type: object
      properties:
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        bankLocation:
          type: string
          example: Newark, NJ
        bankTelephoneNumber:
          type: string
          example: 973-555-0100
        bankName:
          type: string
          example: First National Bank
        bankId:
          type: string
          example: BNK-10001
        routingNumber:
          type: string
          example: "021000021"
        bankAccountNumber:
          type: string
          example: "000123456789"
        accountType:
          type: string
          enum:
            - CHECKING
            - SAVINGS
            - CREDITCARDACCOUNT
            - DEBITCARDACCOUNT
            - BROKERAGEACCOUNT
            - CERTIFICATEOFDEPOSITACCOUNT
          example: CHECKING
        accountStatus:
          type: string
          example: ACTIVE
        nameOnAccount:
          type: string
          example: Jane Smith
        primaryAccount:
          type: boolean
          example: true
        branchName:
          type: string
          example: Newark Branch
        bankAccountPurposeEnum:
          type: string
          enum:
            - PREMIUMBILLING
            - LOANINTERESTBILLING
            - LOANPRINCIPALBILLING
            - DISBURSEMENTS
            - PAYOUT
            - ONETIMEPREMIUMBILLING
            - ONETIMEWIRE
            - OPERATING
          example: DISBURSEMENTS
        address:
          $ref: "#/components/schemas/ClaimAddress"
    ClaimDtccDetails:
      type: object
      properties:
        payeeName:
          type: string
          example: Jane Smith
        participantId:
          type: string
          example: DTCC-10001
        participantDesc:
          type: string
          example: Primary Participant
        contractBinNumber:
          type: string
          example: BIN-10001
    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
  examples:
    failureTransactionResponse:
      value:
        status: failure
        validationResult:
          - errorCode: BPM.NM.005
            attribute: null
            error: Amount request is invalid.
            resolution: Please check the One Time Premium Amount and submit the request
              again.
          - errorCode: BPM.NM.003
            attribute: null
            error: Party information does not match with information in the Zahara system.
            resolution: Please validate the party information and submit the request again.
  securitySchemes:
    Auth0:
      type: openIdConnect
      openIdConnectUrl: https://login.qa.zinnia.com/.well-known/openid-configuration
      x-kong-security-openid-connect:
        config:
          run_on_preflight: true
          scopes_claim:
            - https://qa.api.zinnia.io/permissions
          audience_claim:
            - aud
          audience_required:
            - https://qa.api.zinnia.io
          client_id:
            - client_id
          auth_methods:
            - bearer
        enabled: true
        protocols:
          - grpc
          - grpcs
          - http
          - https
```