---
title: "BeneficiariesPatch"
url: "https://developers.zinnia.com/apis/new-business/versions/b8532e16-b28e-4393-9305-def50b91e40e/schemas/BeneficiariesPatch"
---

> Full API specification: https://developers.zinnia.com/apis/new-business/versions/b8532e16-b28e-4393-9305-def50b91e40e.md

# BeneficiariesPatch

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia New Business API.
  version: 0.9.8
servers:
  - url: https://qa.api.zinnia.io
    description: QA Environment
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://uat.api.zinnia.io
    description: UAT Environment
  - url: https://api.zinnia.io
    description: PROD Environment
components:
  schemas:
    BeneficiaryDetail:
      type: object
      required:
        - partyId
        - percentage
      properties:
        partyId:
          type: string
          format: uuid
          description: Reference to the beneficiary party ID
          example: 5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f
        percentage:
          type: integer
          minimum: 0
          maximum: 100
          description: Percentage share of the benefit
          example: 50
        irrevocable:
          type: boolean
          description: Indicates if the beneficiary designation is irrevocable
          example: true
    BeneficiariesPatch:
      type: object
      properties:
        primary:
          type: array
          items:
            $ref: "#/components/schemas/BeneficiaryDetail"
          description: List of primary beneficiaries
        contingent:
          type: array
          items:
            $ref: "#/components/schemas/BeneficiaryDetail"
          description: List of contingent beneficiaries
```