Create a shareholder

POST /api/v2/shareholder
Personal access token & O auth2

Headers

application/json

Body Required

  • business_uuid string Required

    The UUID of the business this shareholder is associated with.

  • full_name string Required

    The shareholder's full name.

  • ownership_percentage number Required

    The percentage of ownership this shareholder has, between 0 and 100.

  • shares_owned integer Required

    The number of shares this shareholder owns.

  • voting_rights string Required

    The voting rights this shareholder has.

  • role string Required

    The role of this shareholder.

  • appointed_at date Required

    The date this shareholder was appointed.

  • registered_address string Required

    The registered address of this shareholder.

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.

    • 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.
POST /api/v2/shareholder 
curl \
 --request POST https://api.plannrcrm.com/api/v2/shareholder \
 --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":"ac3355c3-b292-4b5f-8607-06a034d3a00e","full_name":"John Doe","ownership_percentage":25.0,"shares_owned":100,"voting_rights":"All","role":"Bozo","appointed_at":"2022-03-17","registered_address":"123 Main St"}'
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": "ac3355c3-b292-4b5f-8607-06a034d3a00e",
  "full_name": "John Doe",
  "ownership_percentage": 25.0,
  "shares_owned": 100,
  "voting_rights": "All",
  "role": "Bozo",
  "appointed_at": "2022-03-17",
  "registered_address": "123 Main St"
}
Response examples (201) 
{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "cf5bb363-8154-4925-b1f1-7f1e28b75121",
    "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": "f4f46297-e4ed-4591-a82c-454b138661e9",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "96cebff4-37e8-44d8-b2ae-2d97f8878035",
    "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": "Isobel Rose",
  "created_at": "2025-03-10T22:05:33+00:00",
  "percentage": 6.73,
  "updated_at": "2025-03-10T22:05:33+00:00",
  "appointed_at": "2020-09-27",
  "shares_owned": 52.16,
  "voting_rights": "No",
  "registered_address_full": "168 Jackson Junctions\nStewartfort\nHR9 7GB"
}