Create an introducer [Deprecated: Use create an account route]

POST /api/v1/introducer

Headers

application/json

Body Required

title string

Title
first_name string Required

First name
last_name string Required

Last name
entity_name string Required

Entity/business name
email string Required

Account email
assigned_adviser_uuid string

UUID of the account that this account reports to
groups array[string]

Group uuids belonging to the firm.
charge_split_schema_uuid string

Charge split schema that is always used when adding a charge split for this introducer

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.
- type string
  
  Account type
- role string
  
  Account role
- first_name string
  
  First name
- last_name string
  
  Last name
- name string
  
  Name
- email string
  
  Email
- firm object
  
  Firm
  
  Additional properties are allowed.
- primary_phone_number object
  
  Primary phone number
  
  Additional properties are allowed.
- primary_email object
  
  Primary email
  
  Additional properties are allowed.
- current_time_entry object
  
  Current time entry
  
  Additional properties are allowed.
- assigned_adviser object
  
  Assigned adviser
  
  Additional properties are allowed.
- assigned_administrator object
  
  Assigned administrator
  
  Additional properties are allowed.
- assigned_paraplanner object
  
  Assigned paraplanner
  
  Additional properties are allowed.
- introduced_by object
  
  Introduced by
  
  Additional properties are allowed.
- groups array[object]
  
  Groups
  
  Additional properties are allowed.
- tags array[object]
  
  Tags
  
  Additional properties are allowed.
- owners array[object]
  
  Accounts that own this account
  
  Additional properties are allowed.
- first_contact_date string
  
  First contact date
- next_review_date string
  
  Next review date
- previous_review_date string
  
  Previous review date
- anniversary_review_date string
  
  Anniversary review date
- with_login boolean
  
  Denotes whether the account has a login to Plannr
- has_joint_account boolean
  
  Denotes whether this account belongs to a joint account too
- can_be_deleted string
  
  Denotes if the account can be deleted
- custom_fields array[object]
  
  Any custom fields on the model.
  
  Additional properties are allowed.
- external_references array[object]
  
  The external references that have been added to the client.
  
  Additional properties are allowed.

POST /api/v1/introducer

curl \
 -X POST https://api.plannrcrm.com/api/v1/introducer \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"title":"Mr","first_name":"Patrick","last_name":"Stanton","entity_name":"PatrickCo","email":"patrick@plannercrm.com","assigned_adviser_uuid":"efba37e2-af19-4773-b42d-037d96055e22","groups":["456bdb26-7de6-439c-a3bc-48a1181d07ea","2150ec4f-5214-4ee7-8c8a-92f72eab4612"],"charge_split_schema_uuid":"a7501575-5f6e-434e-b47e-e5e314083981"}'

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
{
  "title": "Mr",
  "first_name": "Patrick",
  "last_name": "Stanton",
  "entity_name": "PatrickCo",
  "email": "patrick@plannercrm.com",
  "assigned_adviser_uuid": "efba37e2-af19-4773-b42d-037d96055e22",
  "groups": [
    "456bdb26-7de6-439c-a3bc-48a1181d07ea",
    "2150ec4f-5214-4ee7-8c8a-92f72eab4612"
  ],
  "charge_split_schema_uuid": "a7501575-5f6e-434e-b47e-e5e314083981"
}

Response examples (200)

{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "36e63469-bb97-4e2a-aa3c-df1d027f431a",
    "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-01-17T11:18:29+00:00",
    "updated_at": "2025-01-17T11:18:29+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!"
  },
  "name": "Gareth Thompson",
  "role": "client",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "bdac79e8-3b66-47f2-bb28-d11dbb8ab952",
      "colour": "#ef4582",
      "created_at": "2025-01-17T11:18:29+00:00",
      "updated_at": "2025-01-17T11:18:29+00:00"
    }
  ],
  "type": "client",
  "uuid": "5217bd01-6eee-4b04-ac02-3eecf2457fe5",
  "email": "gareth@codepotato.co.uk",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "f6172960-12f9-4591-8f7c-89fa02fb2a2c",
      "created_at": "2025-01-17T11:18:29+00:00",
      "updated_at": "2025-01-17T11:18:29+00:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "50101b0b-d3b6-4ff5-b116-c3aa42729620",
          "description": "UUID of the account"
        },
        "email": {
          "example": "gareth@codepotato.co.uk",
          "description": "Email of the account"
        },
        "last_name": {
          "example": "Thompson",
          "description": "Last name of the account"
        },
        "first_name": {
          "example": "Gareth",
          "description": "First name of the account"
        }
      },
      "participants_count": "3"
    }
  ],
  "owners": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "a6a84329-cc47-423f-9463-4130df455bb3",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "last_name": "Thompson",
      "created_at": "2025-01-17T11:18:29+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-01-17T11:18:29+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-01-17T11:18:29+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2025-01-17T11:18:29+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "previous_review_date": "2025-01-17T11:18:29+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2025-01-17T11:18:29+00:00"
    }
  ],
  "last_name": "Thompson",
  "created_at": "2025-01-17T11:18:29+00:00",
  "first_name": "Gareth",
  "updated_at": "2025-01-17T11:18:29+00:00",
  "with_login": true,
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "46b21567-ea2e-4856-871e-44b774ece49b",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-01-17T11:18:29+00:00",
      "updated_at": "2025-01-17T11:18:29+00:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "introduced_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "a77f6d06-ff3e-4ad9-b1fd-7ab7d8ee6788",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-17T11:18:29+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:29+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-01-17T11:18:29+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-17T11:18:29+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-17T11:18:29+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-17T11:18:29+00:00"
  },
  "primary_email": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "fbade699-ae18-4cb2-84be-99a99186acb5",
    "value": "+443330903630",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-01-17T11:18:29+00:00",
    "updated_at": "2025-01-17T11:18:29+00:00",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    }
  },
  "can_be_deleted": "false",
  "assigned_adviser": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "c0e29f64-84b2-43b3-8e87-b23034a9c009",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-17T11:18:29+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:29+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-01-17T11:18:29+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-17T11:18:29+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-17T11:18:29+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-17T11:18:29+00:00"
  },
  "next_review_date": "2025-01-17T11:18:29+00:00",
  "has_joint_account": true,
  "current_time_entry": {
    "name": "Research",
    "uuid": "6f4d600e-67a4-4468-a433-919c87a06826",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "end_date": "2025-01-17T10:56:29+00:00",
    "is_active": true,
    "trackable": "App\\Http\\Resources\\MinimalAccountResource",
    "created_at": "2025-01-17T11:18:29+00:00",
    "start_date": "2025-01-17T10:28:29+00:00",
    "updated_at": "2025-01-17T11:18:29+00:00",
    "description": "This is a description.",
    "trackable_type": "Client",
    "total_time_in_minutes": 28,
    "computed_time_elapsed_in_seconds": 1680
  },
  "first_contact_date": "2025-01-17T11:18:29+00:00",
  "external_references": [
    {
      "uuid": "d3b30efd-5d45-45da-8ab7-48af627bbc03",
      "reference": "AB123456",
      "created_at": "2025-01-17T11:18:29+00:00",
      "updated_at": "2025-01-17T11:18:29+00:00",
      "third_party": "nucleus"
    }
  ],
  "assigned_paraplanner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "8a5025a9-cec9-43a0-9cf0-5c06d60bcd5e",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-17T11:18:29+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:29+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-01-17T11:18:29+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-17T11:18:29+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-17T11:18:29+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-17T11:18:29+00:00"
  },
  "previous_review_date": "2025-01-17T11:18:29+00:00",
  "primary_phone_number": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "52632ca5-a779-43c9-b124-26403ea672c8",
    "value": "+443330903630",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-01-17T11:18:29+00:00",
    "updated_at": "2025-01-17T11:18:29+00:00",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    }
  },
  "assigned_administrator": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "8495cf6e-62bb-4f03-9e6e-3a5fc4b49737",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-17T11:18:29+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:29+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-01-17T11:18:29+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-17T11:18:29+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-17T11:18:29+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-17T11:18:29+00:00"
  },
  "anniversary_review_date": "2025-01-17T11:18:29+00:00"
}