Create an introducer [Deprecated: Use create an account route]
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
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
POST
/api/v1/introducer
curl \
--request POST 'https://api.plannrcrm.com/api/v1/introducer' \
--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 '{"title":"Mr","first_name":"Patrick","last_name":"Stanton","entity_name":"PatrickCo","email":"patrick@plannercrm.com","assigned_adviser_uuid":"32effaf4-59ea-4bae-9cea-8d3f87c36159","groups":["3aaf9355-ce93-435f-b3b6-2220f592fd0e","10c4b49e-12ad-4c70-af72-92e8b05d7870"],"charge_split_schema_uuid":"7958e6ad-cdbd-4f85-a750-f7754d1fad45"}'
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": "32effaf4-59ea-4bae-9cea-8d3f87c36159",
"groups": [
"3aaf9355-ce93-435f-b3b6-2220f592fd0e",
"10c4b49e-12ad-4c70-af72-92e8b05d7870"
],
"charge_split_schema_uuid": "7958e6ad-cdbd-4f85-a750-f7754d1fad45"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "bea2a52b-15f4-4bde-b91f-593ff0d697a3",
"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-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+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",
"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
},
"name": "Gareth Thompson",
"role": "client",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "29b12c54-322a-4d8e-83ca-8476f2e1f155",
"colour": "#ef4582",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00"
}
],
"type": "client",
"uuid": "30a0f701-fa30-483c-b6e6-725911d5d174",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "bad0e662-e2d3-4a98-9584-722cf55089ac",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "3133919a-e321-4a02-8ce1-aae0172bf6c3",
"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": "0dac26d9-e0ea-45e7-a2ba-3b43ab46786d",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-22T13:44:18+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:18+01:00",
"with_login": true,
"inactive_at": "2025-04-22",
"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-04-22T13:44:18+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-22T13:44:18+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-04-22T13:44:18+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-22T13:44:18+01:00"
}
],
"last_name": "Thompson",
"created_at": "2025-04-22T13:44:18+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:18+01:00",
"with_login": true,
"inactive_at": "2025-04-22",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "d623b09e-5b8a-4073-bd97-950287cab9c0",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01: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": "4d2c5519-4703-4e14-88dd-1861da6186a3",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-22T13:44:18+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:18+01:00",
"with_login": true,
"inactive_at": "2025-04-22",
"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-04-22T13:44:18+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-22T13:44:18+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-04-22T13:44:18+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-22T13:44:18+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "7543195c-c164-4c26-be36-2f669b5b4fb1",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01: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": "b0db7bb3-8a73-457c-9fe3-d5dba91a08e0",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-22T13:44:18+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:18+01:00",
"with_login": true,
"inactive_at": "2025-04-22",
"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-04-22T13:44:18+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-22T13:44:18+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-04-22T13:44:18+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-22T13:44:18+01:00"
},
"next_review_date": "2025-04-22T13:44:18+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "0f6ad450-e61d-4dcc-806d-daa6ac5a87bf",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-04-22T13:22:18+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-04-22T13:44:18+01:00",
"start_date": "2025-04-22T12:54:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00",
"description": "This is a description.",
"trackable_type": "Client",
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680
},
"first_contact_date": "2025-04-22T13:44:18+01:00",
"external_references": [
{
"uuid": "9c2b0d7c-d747-42fc-a3d9-238ecef1b513",
"reference": "AB123456",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00",
"third_party": "nucleus"
}
],
"assigned_paraplanner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "61258cf9-415c-43aa-a981-d6e17760144c",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-22T13:44:18+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:18+01:00",
"with_login": true,
"inactive_at": "2025-04-22",
"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-04-22T13:44:18+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-22T13:44:18+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-04-22T13:44:18+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-22T13:44:18+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "8bc52531-2dae-4dd1-80cb-58e3def65b27",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00",
"joint_account_uuid": "a7cc570d-779e-4cd5-aae2-6659ca03a08b"
},
"ownership_percentage": 100,
"previous_review_date": "2025-04-22T13:44:18+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "ee2779ec-6ae1-489d-9679-a2c115e7ad31",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01: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": "f5437dc4-d475-47dd-a73d-194a5f6c6399",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-22T13:44:18+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:18+01:00",
"with_login": true,
"inactive_at": "2025-04-22",
"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-04-22T13:44:18+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-22T13:44:18+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-04-22T13:44:18+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-22T13:44:18+01:00"
},
"anniversary_review_date": "2025-04-22T13:44:18+01:00"
}