Update a plan's ownership without updating the rest of the plan Run in API Explorer

PUT /api/v1/plans/{plan_uuid}/ownership
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • plan_uuid string Required
  • plan string Required

    The UUID of the plan

application/json

Body

  • accounts array[object] Required

    List of account ownership details.

    Hide accounts attributes Show accounts attributes object
    • account_uuid string(uuid)

      The account UUID of the owner.

    • ownership_percentage number(float) | null

      The ownership percentage for this account. If omitted, the ownership will be assumed to be equal among all accounts.

      Minimum value is 0.0, maximum value is 100.0.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string
    • created_at string
    • updated_at string
    • opened_at string
    • name string
    • type string
    • sub_type string
    • abstract_type string
    • policy_number string
    • proposal_reference string
    • status string
    • inactive_at string
    • inactive_reason string
    • agency_in_your_name boolean
    • agency_in_your_name_from string
    • originally_sold_by_firm boolean
    • under_advice boolean
    • visible_on_client_portal boolean
    • include_in_client_valuation boolean
    • show_on_joint boolean
    • shown_on_circles boolean
    • review_date string
    • on_panel boolean
    • is_group_scheme boolean
    • is_sub_group_scheme boolean
    • is_group_scheme_member boolean
    • advice_area string
    • main_account object
      Hide main_account attributes Show main_account attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • policy_number string
      • latest_valuation string
      • is_main_account boolean
      • active_portfolio string
      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
    • sub_accounts array[object]
      Hide sub_accounts attributes Show sub_accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • policy_number string
      • latest_valuation string
      • is_main_account boolean
      • active_portfolio string
      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
    • provider object
      Hide provider attributes Show provider attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
    • covers array[object]
      Hide covers attributes Show covers attributes object
      • uuid string
      • created_at string
      • updated_at string
      • cover_type string
      • benefit_amount object
        Hide benefit_amount attributes Show benefit_amount attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • benefit_frequency string
      • benefit_status string
      • excess object
        Hide excess attributes Show excess attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • indexation number
      • client string
    • claims array[object]
      Hide claims attributes Show claims attributes object
      • uuid string
      • created_at string
      • updated_at string
      • claim_amount object
        Hide claim_amount attributes Show claim_amount attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • claim_start_date string
      • claim_end_date string
      • claim_notes string
      • client string
    • total_benefit_amount object
      Hide total_benefit_amount attributes Show total_benefit_amount attributes object
      • amount object
        Hide amount attributes Show amount attributes object
        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object
        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object
        • example string
        • description string
    • total_benefits object
      Hide total_benefits attributes Show total_benefits attributes object
      • critical_illness object
        Hide critical_illness attributes Show critical_illness attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • family_income_benefit object
        Hide family_income_benefit attributes Show family_income_benefit attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
    • latest_valuations array[object]
      Hide latest_valuations attributes Show latest_valuations attributes object
      • uuid string
      • created_at string
      • updated_at string
      • valued_at string
      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • sub_account string
    • value object
      Hide value attributes Show value attributes object
      • amount object
        Hide amount attributes Show amount attributes object
        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object
        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object
        • example string
        • description string
    • valued_at string
    • original_valued_at string
    • client object
      Hide client attributes Show client attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • custom_fields string
      • external_references string
    • accounts array[object]
      Hide accounts attributes Show accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • custom_fields string
      • external_references string
    • seller object
      Hide seller attributes Show seller attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • custom_fields string
      • external_references string
    • linked_owners array[object]
      Hide linked_owners attributes Show linked_owners attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • custom_fields string
      • external_references string
    • linked_plans array[object]
      Hide linked_plans attributes Show linked_plans attributes object
      • uuid string
      • created_at string
      • updated_at string
      • opened_at string
      • name string
      • type string
      • sub_type string
      • abstract_type string
      • policy_number string
      • proposal_reference string
      • status string
      • inactive_at string
      • inactive_reason string
      • agency_in_your_name boolean
      • agency_in_your_name_from string
      • originally_sold_by_firm boolean
      • under_advice boolean
      • visible_on_client_portal boolean
      • include_in_client_valuation boolean
      • show_on_joint boolean
      • shown_on_circles boolean
      • review_date string
      • on_panel boolean
      • is_group_scheme boolean
      • is_sub_group_scheme boolean
      • is_group_scheme_member boolean
      • advice_area string
      • main_account string
      • sub_accounts string
      • provider string
      • covers string
      • claims string
      • total_benefit_amount object
        Hide total_benefit_amount attributes Show total_benefit_amount attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • total_benefits object
        Hide total_benefits attributes Show total_benefits attributes object
        • critical_illness object
          Hide critical_illness attributes Show critical_illness attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
        • family_income_benefit object
          Hide family_income_benefit attributes Show family_income_benefit attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
      • latest_valuations string
      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • valued_at string
      • original_valued_at string
      • client string
      • accounts string
      • seller string
      • linked_owners string
      • linked_plans string
      • visible_to_circles string
      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
      • cases string
      • tags string
      • is_wrap_product boolean
      • is_wrap_child boolean
      • wrap string
      • wrap_children string
      • linked_policy_numbers string
      • can_be_deleted string
      • contract_enquiry_account string
      • custom_fields string
      • external_references string
    • visible_to_circles object
      Hide visible_to_circles attributes Show visible_to_circles attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • photo_url string
      • bg_colour string
      • accounts string
      • groups string
      • joint_account_uuid string
      • login_access_level string
      • external_references string
    • statistics object
      Hide statistics attribute Show statistics attribute object
      • recent_growth integer
    • cases array[object]
      Hide cases attributes Show cases attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • status string
      • type string
      • review_at string
      • assigned_to_uuids array[string]
      • group_uuids array[string]
      • completed_at string
      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • status_position integer
      • participants_count integer
      • participants string
      • task_board_uuid string
      • plans string
      • custom_fields string
    • tags array[object]
      Hide tags attributes Show tags attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • colour string
    • is_wrap_product boolean
    • is_wrap_child boolean
    • wrap object
      Hide wrap attributes Show wrap attributes object
      • uuid string
      • created_at string
      • updated_at string
      • opened_at string
      • name string
      • type string
      • sub_type string
      • abstract_type string
      • policy_number string
      • proposal_reference string
      • status string
      • inactive_at string
      • inactive_reason string
      • agency_in_your_name boolean
      • agency_in_your_name_from string
      • originally_sold_by_firm boolean
      • under_advice boolean
      • visible_on_client_portal boolean
      • include_in_client_valuation boolean
      • show_on_joint boolean
      • shown_on_circles boolean
      • review_date string
      • on_panel boolean
      • is_group_scheme boolean
      • is_sub_group_scheme boolean
      • is_group_scheme_member boolean
      • advice_area string
      • main_account string
      • sub_accounts string
      • provider string
      • covers string
      • claims string
      • total_benefit_amount object
        Hide total_benefit_amount attributes Show total_benefit_amount attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • total_benefits object
        Hide total_benefits attributes Show total_benefits attributes object
        • critical_illness object
          Hide critical_illness attributes Show critical_illness attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
        • family_income_benefit object
          Hide family_income_benefit attributes Show family_income_benefit attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
      • latest_valuations string
      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • valued_at string
      • original_valued_at string
      • client string
      • accounts string
      • seller string
      • linked_owners string
      • linked_plans string
      • visible_to_circles string
      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
      • cases string
      • tags string
      • is_wrap_product boolean
      • is_wrap_child boolean
      • wrap string
      • wrap_children string
      • linked_policy_numbers string
      • can_be_deleted string
      • contract_enquiry_account string
      • custom_fields string
      • external_references string
    • wrap_children array[object]
      Hide wrap_children attributes Show wrap_children attributes object
      • uuid string
      • created_at string
      • updated_at string
      • opened_at string
      • name string
      • type string
      • sub_type string
      • abstract_type string
      • policy_number string
      • proposal_reference string
      • status string
      • inactive_at string
      • inactive_reason string
      • agency_in_your_name boolean
      • agency_in_your_name_from string
      • originally_sold_by_firm boolean
      • under_advice boolean
      • visible_on_client_portal boolean
      • include_in_client_valuation boolean
      • show_on_joint boolean
      • shown_on_circles boolean
      • review_date string
      • on_panel boolean
      • is_group_scheme boolean
      • is_sub_group_scheme boolean
      • is_group_scheme_member boolean
      • advice_area string
      • main_account string
      • sub_accounts string
      • provider string
      • covers string
      • claims string
      • total_benefit_amount object
        Hide total_benefit_amount attributes Show total_benefit_amount attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • total_benefits object
        Hide total_benefits attributes Show total_benefits attributes object
        • critical_illness object
          Hide critical_illness attributes Show critical_illness attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
        • family_income_benefit object
          Hide family_income_benefit attributes Show family_income_benefit attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
      • latest_valuations string
      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • valued_at string
      • original_valued_at string
      • client string
      • accounts string
      • seller string
      • linked_owners string
      • linked_plans string
      • visible_to_circles string
      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
      • cases string
      • tags string
      • is_wrap_product boolean
      • is_wrap_child boolean
      • wrap string
      • wrap_children string
      • linked_policy_numbers string
      • can_be_deleted string
      • contract_enquiry_account string
      • custom_fields string
      • external_references string
    • linked_policy_numbers array[object]
      Hide linked_policy_numbers attributes Show linked_policy_numbers attributes object
      • uuid string
      • created_at string
      • updated_at string
      • linked_policy_number string
      • plan string
    • can_be_deleted string
    • contract_enquiry_account object
      Hide contract_enquiry_account attributes Show contract_enquiry_account attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • custom_fields string
      • external_references string
    • custom_fields array[object]
      Hide custom_fields attributes Show custom_fields attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • name string
      • reference string
      • is_required boolean
      • value string
      • selection_options array[string]
      • help_text string
    • external_references array[object]
      Hide external_references attributes Show external_references attributes object
      • uuid string
      • created_at string
      • updated_at string
      • third_party string
      • reference string
PUT /api/v1/plans/{plan_uuid}/ownership 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/ownership' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"accounts":[{"account_uuid":"119fa607-5ed0-48e8-94e3-df0091dcd0a8","ownership_percentage":25.0}]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "accounts": [
    {
      "account_uuid": "119fa607-5ed0-48e8-94e3-df0091dcd0a8",
      "ownership_percentage": 25.0
    }
  ]
}
Response examples (200) 
{
  "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"
  }
}