Update a sub account

PUT /api/v1/plans/{plan_uuid}/sub-accounts/{id}

Headers

Authorization string
Content-Type string
Accept string

Path parameters

plan_uuid string Required
id string Required

The ID of the sub account.

application/json

Body

name string

Descriptive name of the sub account
policy_number string

Sub account policy number
proposal_reference string

Sub account proposal number
active_portfolio_uuid string

The active portfolio UUID of the sub-account.

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  UUID of the sub account
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was created.
- name string
  
  Descriptive name of the sub account
- policy_number string
  
  Provider reference of the sub account
- latest_valuation object
  
  The latest valuation of the sub account
  
  Additional properties are allowed.
- is_main_account boolean
  
  Denotes if the sub account a main account of the plan
- active_portfolio object
  
  The active portfolio of the sub account
  
  Additional properties are allowed.
- statistics object
  
  The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
  
  Additional properties are allowed.

PUT /api/v1/plans/{plan_uuid}/sub-accounts/{id}

curl \
 -X PUT https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts/id \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"name":"Johns ISA","policy_number":"AVF-4355432","proposal_reference":"BtMWiy0JwHtogU4","active_portfolio_uuid":"f0d139f5-d614-4e29-92ab-d61698bdabd0"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "name": "Johns ISA",
  "policy_number": "AVF-4355432",
  "proposal_reference": "BtMWiy0JwHtogU4",
  "active_portfolio_uuid": "f0d139f5-d614-4e29-92ab-d61698bdabd0"
}

Response examples (200)

{
  "name": "John's ISA",
  "uuid": "632e7990-42d1-486d-a69a-17a8dc5acf50",
  "created_at": "2024-11-20T13:24:02+00:00",
  "statistics": {
    "recent_growth": 100
  },
  "updated_at": "2024-11-20T13:24:02+00:00",
  "policy_number": "AVI-4837",
  "is_main_account": false,
  "active_portfolio": {
    "name": "Risky Portfolio",
    "uuid": "5a0687ee-b730-4bd2-84fe-2fda71ab6e81",
    "created_at": "2024-11-20T13:24:02+00:00",
    "updated_at": "2024-11-20T13:24:02+00:00",
    "is_proposed": true,
    "proposed_at": "2024-11-20T00:00:00+00:00"
  },
  "latest_valuation": {
    "uuid": "b26d992f-1ae4-4c3a-8280-869d8571572c",
    "value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "valued_at": "2024-11-20T13:24:02+00:00",
    "created_at": "2024-11-20T13:24:02+00:00",
    "updated_at": "2024-11-20T13:24:02+00:00",
    "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
  }
}