Create beneficiary for a plan

POST /api/v1/plans/{plan_uuid}/beneficiary
Personal access token & OAuth2

Headers

Path parameters

application/json

Body Required

  • name string Required

    Name of the beneficiary.

  • percentage number Required

    Percentage due to the beneficiary.

Responses

  • 201 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • name string

      Beneficiary name.

    • percentage integer

      Beneficiary percentage.

    • cover object

      Cover this beneficiary is for.

      Additional properties are allowed.
POST /api/v1/plans/{plan_uuid}/beneficiary 
curl \
 --request POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/beneficiary \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"John Smith","percentage":50.25}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "John Smith",
  "percentage": 50.25
}
Response examples (201) 
{
  "name": "Beneficiary name",
  "uuid": "67252e12-381f-4975-bafd-f6dd4577d0d6",
  "cover": {
    "uuid": "8569c53a-18c4-458d-ae04-4bddc2e4ee80",
    "client": "App\\Http\\Resources\\AccountResource",
    "excess": {
      "amount": {
        "example": "10000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£100.00",
        "description": "Money amount formatted with currency"
      }
    },
    "cover_type": "critical_illness",
    "created_at": "2025-02-20T10:13:04+00:00",
    "indexation": 1.4,
    "updated_at": "2025-02-20T10:13:04+00:00",
    "benefit_amount": {
      "amount": {
        "example": "25000000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£250,000.00",
        "description": "Money amount formatted with currency"
      }
    },
    "benefit_status": "active",
    "benefit_frequency": "monthly"
  },
  "created_at": "2025-02-20T10:13:04+00:00",
  "percentage": 50,
  "updated_at": "2025-02-20T10:13:04+00:00"
}