Update a shareholder

PUT /api/v2/shareholder/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

uuid string Required

application/json

Body Required

business_uuid string Required

The UUID of the business this shareholder should associate with. Leave null to clear the association with the current business.
full_name string

The updated name of the shareholder.
role string

The updated role of the shareholder.
appointed_at date

The updated appointed date of the shareholder.
address array[string]

The updated address of the shareholder.
percentage number

The updated percentage of the shareholder.
shares_owned integer

The updated number of shares owned by the shareholder.
voting_rights string

The updated voting rights of the shareholder.

Responses

200 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.
- full_name string
  
  Full name of the shareholder
- role string
  
  Role of the shareholder
- appointed_at string
  
  Date the shareholder was appointed
- address object
  
  Registered address of the shareholder
  
  Hide address attributes Show address attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  address_1 string
  
  address_2 string
  
  address_3 string
  
  address_4 string
  
  town_city string
  
  county string
  
  postcode string
  
  country string
  
  move_in_date string
  
  accounts string
- percentage number
  
  Percentage of shares owned by the shareholder
- shares_owned number
  
  Number of shares owned by the shareholder
- voting_rights string
  
  Voting rights of the shareholder
- firm object
  
  Firm the shareholder is associated with
  
  Hide firm attributes Show firm attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  address_1 string
  
  address_2 string
  
  town_city string
  
  county string
  
  postcode string
  
  country string
  
  regulatory_text string
  
  logo string
  
  logo_icon string
  
  brand_colours object
  
  Hide brand_colours attributes Show brand_colours attributes object
  
  sidebar_background string
  
  sidebar_accent string
  
  sidebar_text string
  
  sidebar_hover string
  
  sidebar_active string
  
  sidebar_title_background string
  
  sidebar_title_primary string
  
  sidebar_title_secondary string
  
  sidebar_title_secondary_hover string
  
  email_background string
  
  email_logo_background_panel string
  
  email_sub_text string
  
  email_button_background string
  
  email_button_text string
  
  portal_sidebar_button_background string
  
  portal_sidebar_button_hover string
  
  portal_sidebar_button_active string
  
  portal_brand_title string
  
  portal_brand_sub_title string
  
  portal_sidebar_title string
  
  portal_sidebar_text string
  
  portal_sidebar_text_hover string
  
  portal_sidebar_text_active string
  
  portal_sidebar_icon string
  
  portal_sidebar_icon_hover string
  
  portal_sidebar_icon_active string
  
  portal_background string
  
  portal_sidebar_account_title string
  
  portal_account_email string
  
  portal_sidebar_divider string
  
  portal_dashboard_bg_one string
  
  portal_dashboard_bg_two string
  
  is_subscribed boolean
  
  addon_subscriptions string
  
  keep_deleted_files_for integer
  
  tax number
  
  month_end integer
  
  statement_frequency string
  
  billing object
  
  Hide billing attributes Show billing attributes object
  
  invoice_address_1 string
  
  invoice_address_2 string
  
  invoice_town_city string
  
  invoice_county string
  
  invoice_postcode string
  
  invoice_country string
  
  invoice_email string
  
  task_board_template string
  
  ip_whitelist array[string]
  
  welcome_paragraph_html string
  
  email_welcome_paragraph_html string
  
  show_fact_find_illustrations boolean
- account object
  
  Business the shareholder is associated with
  
  Hide account attributes Show 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
  
  custom_fields string
  
  external_references string

PUT /api/v2/shareholder/{uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v2/shareholder/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"business_uuid":"44394e7d-f43b-4a1d-978c-5ae91f3f1a0a","full_name":"Jane Doe","role":"Clown","appointed_at":"2022-03-17","address":[{"name":{"type":"string","example":"Work Address","required":false,"description":"Name of the address"},"county":{"type":"string","example":"Hampshire","required":false,"description":"County"},"country":{"type":"string","example":"United Kingdom","required":false,"description":"Country"},"postcode":{"type":"string","example":"PO7 7YH","required":false,"description":"Postcode"},"address_1":{"type":"string","example":"Suite E","required":false,"description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","required":false,"description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","required":false,"description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","required":false,"description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","required":false,"description":"Town/City"},"move_in_date":{"type":"string","example":"2024-06-20","required":false,"description":"Move in date"},"moved_in_year":{"type":"integer","example":2022,"required":false,"description":"The year the client moved into this address."},"moved_in_month":{"type":"integer","example":6,"required":false,"description":"The month the client moved into this address."},"moved_out_year":{"type":"integer","example":2024,"required":false,"description":"The year the client moved out of this address."},"moved_out_month":{"type":"integer","example":1,"required":false,"description":"The month the client moved out of this address."},"residential_status":{"type":"string","example":"homeowner","required":false,"description":"The client's residential status when living at the address."},"residential_status_other":{"type":"string","example":"Non-tenant occupier","required":false,"description":"The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."}}],"percentage":25.5,"shares_owned":100,"voting_rights":"All"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "business_uuid": "44394e7d-f43b-4a1d-978c-5ae91f3f1a0a",
  "full_name": "Jane Doe",
  "role": "Clown",
  "appointed_at": "2022-03-17",
  "address": [
    {
      "name": {
        "type": "string",
        "example": "Work Address",
        "required": false,
        "description": "Name of the address"
      },
      "county": {
        "type": "string",
        "example": "Hampshire",
        "required": false,
        "description": "County"
      },
      "country": {
        "type": "string",
        "example": "United Kingdom",
        "required": false,
        "description": "Country"
      },
      "postcode": {
        "type": "string",
        "example": "PO7 7YH",
        "required": false,
        "description": "Postcode"
      },
      "address_1": {
        "type": "string",
        "example": "Suite E",
        "required": false,
        "description": "First line of the address"
      },
      "address_2": {
        "type": "string",
        "example": "5 The Briars",
        "required": false,
        "description": "Second line of the address"
      },
      "address_3": {
        "type": "string",
        "example": "Waterberry Drive",
        "required": false,
        "description": "Third line of the address"
      },
      "address_4": {
        "type": "string",
        "example": "The Innovative Centre",
        "required": false,
        "description": "Fourth line of the address"
      },
      "town_city": {
        "type": "string",
        "example": "Waterlooville",
        "required": false,
        "description": "Town/City"
      },
      "move_in_date": {
        "type": "string",
        "example": "2024-06-20",
        "required": false,
        "description": "Move in date"
      },
      "moved_in_year": {
        "type": "integer",
        "example": 2022,
        "required": false,
        "description": "The year the client moved into this address."
      },
      "moved_in_month": {
        "type": "integer",
        "example": 6,
        "required": false,
        "description": "The month the client moved into this address."
      },
      "moved_out_year": {
        "type": "integer",
        "example": 2024,
        "required": false,
        "description": "The year the client moved out of this address."
      },
      "moved_out_month": {
        "type": "integer",
        "example": 1,
        "required": false,
        "description": "The month the client moved out of this address."
      },
      "residential_status": {
        "type": "string",
        "example": "homeowner",
        "required": false,
        "description": "The client's residential status when living at the address."
      },
      "residential_status_other": {
        "type": "string",
        "example": "Non-tenant occupier",
        "required": false,
        "description": "The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."
      }
    }
  ],
  "percentage": 25.5,
  "shares_owned": 100,
  "voting_rights": "All"
}

Response examples (200)

{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "9fa50a2a-5611-4b16-bd18-45e2a327aa11",
    "county": "Hampshire",
    "billing": {
      "invoice_email": "gareth@codepotato.co.uk",
      "invoice_county": "Hampshire",
      "invoice_country": "United Kingdom",
      "invoice_postcode": "PO7 7YH",
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville"
    },
    "country": "United Kingdom",
    "postcode": "PO7 7YH",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "month_end": 25,
    "town_city": "Waterlooville",
    "created_at": "2025-08-07T13:41:48+01:00",
    "updated_at": "2025-08-07T13:41:48+01:00",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "brand_colours": {
      "sidebar_text": "#ffffff",
      "sidebar_hover": "#0A0A42",
      "email_sub_text": "#ffffff",
      "sidebar_accent": "#36367E",
      "sidebar_active": "#53DBB8",
      "email_background": "#0E0E56",
      "email_button_text": "#ffffff",
      "portal_background": "#f6f6f6",
      "portal_brand_title": "#323b4b",
      "sidebar_background": "#0E0E56",
      "portal_sidebar_icon": "#828994",
      "portal_sidebar_text": "#323b4b",
      "portal_account_email": "#828994",
      "portal_sidebar_title": "#11151d",
      "sidebar_title_primary": "#FFC634",
      "portal_brand_sub_title": "#828994",
      "portal_sidebar_divider": "#e3e5e9",
      "email_button_background": "#36367E",
      "portal_dashboard_bg_one": "#EF4583",
      "portal_dashboard_bg_two": "#FFC634",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "portal_sidebar_icon_hover": "#828994",
      "portal_sidebar_text_hover": "#323b4b",
      "portal_sidebar_icon_active": "#828994",
      "portal_sidebar_text_active": "#323b4b",
      "email_logo_background_panel": "#36367E",
      "portal_sidebar_button_hover": "#ffffff",
      "portal_sidebar_account_title": "#11151d",
      "portal_sidebar_button_active": "#ffffff",
      "sidebar_title_secondary_hover": "#ffffff",
      "portal_sidebar_button_background": "#f6f6f6"
    },
    "is_subscribed": true,
    "regulatory_text": "Regulatory text",
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "statement_frequency": "monthly",
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "keep_deleted_files_for": 30,
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!",
    "show_fact_find_illustrations": true
  },
  "role": "Director",
  "uuid": "b4a40354-cf7c-416e-b299-36a182a07d24",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "9df963db-db83-4fd7-9762-cd4505191d32",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-08-07T13:41:48+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-08-07T13:41:48+01:00",
    "with_login": true,
    "inactive_at": "2025-08-07",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-08-07T13:41:48+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-08-07T13:41:48+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-08-07T13:41:48+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-08-07T13:41:48+01:00"
  },
  "address": {
    "name": "Work Address",
    "uuid": "ac4f5a04-772c-47f0-8ad4-f2be32ed05bd",
    "county": "Hampshire",
    "country": "United Kingdom",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "postcode": "PO7 7YH",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "address_3": "The Innovative Centre",
    "address_4": "Waterlooville",
    "town_city": "Waterlooville",
    "created_at": "2025-08-07T13:41:48+01:00",
    "updated_at": "2025-08-07T13:41:48+01:00",
    "move_in_date": "2024-08-07"
  },
  "full_name": "Connor Richards",
  "created_at": "2025-08-07T13:41:48+01:00",
  "percentage": 42.54,
  "updated_at": "2025-08-07T13:41:48+01:00",
  "appointed_at": "2015-01-19",
  "shares_owned": 60.53,
  "voting_rights": "Yes"
}