Update a shareholder

PUT /api/v2/shareholder/{uuid}

Personal access token & O auth2

Headers

Path parameters

uuid integer 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.
registered_address_full string

The updated registered 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
- registered_address_full string
  
  Registered address of the shareholder
- 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
  
  Additional properties are allowed.
- account object
  
  Business the shareholder is associated with
  
  Additional properties are allowed.

PUT /api/v2/shareholder/{uuid}

curl \
 --request PUT https://api.plannrcrm.com/api/v2/shareholder/uuid \
 --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 '{"business_uuid":"1f613abf-546d-46ec-920e-f62b0aed86b8","full_name":"Jane Doe","role":"Clown","appointed_at":"2022-03-17","registered_address_full":"123 Main St","percentage":25.5,"shares_owned":100,"voting_rights":"All"}'

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
{
  "business_uuid": "1f613abf-546d-46ec-920e-f62b0aed86b8",
  "full_name": "Jane Doe",
  "role": "Clown",
  "appointed_at": "2022-03-17",
  "registered_address_full": "123 Main St",
  "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": "70a2e6f1-5add-40fb-8f74-97efd9025154",
    "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-03-10T22:05:33+00:00",
    "updated_at": "2025-03-10T22:05:33+00: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",
      "sidebar_background": "#0E0E56",
      "sidebar_title_primary": "#FFC634",
      "email_button_background": "#36367E",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "email_logo_background_panel": "#36367E",
      "sidebar_title_secondary_hover": "#ffffff"
    },
    "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": "9195e766-9372-476c-932a-0746127eb879",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "7ba6c6cf-0347-49c9-8c1b-6212f8c091d9",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-03-10T22:05:33+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-03-10T22:05:33+00:00",
    "with_login": true,
    "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-03-10T22:05:33+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-03-10T22:05:33+00: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-03-10T22:05:33+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-03-10T22:05:33+00:00"
  },
  "full_name": "Ellie Simpson",
  "created_at": "2025-03-10T22:05:33+00:00",
  "percentage": 16.21,
  "updated_at": "2025-03-10T22:05:33+00:00",
  "appointed_at": "1971-02-06",
  "shares_owned": 37.72,
  "voting_rights": "No",
  "registered_address_full": "799 Allen Key\nPort Dylan\nBH12 2EN"
}