Create an introducer [Deprecated: Use create an account route] Run in API Explorer
Ask AI
POST
/api/v1/introducer
curl \
--request POST 'https://api.plannrcrm.com/api/v1/introducer' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: 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":"89ce3d25-f225-480e-b33a-b1c882d6fee1","groups":["1d45713a-1b53-4636-a727-1c1923dd8cd8","1a44af1c-3e4c-4cd0-82fd-fe05e8035c0a","f4ba033e-8650-4714-bd3e-4771b839748c"],"charge_split_schema_uuid":"a62b2164-ee19-48da-bc14-175bdcb95215"}'
Request examples
# Headers
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": "89ce3d25-f225-480e-b33a-b1c882d6fee1",
"groups": [
"1d45713a-1b53-4636-a727-1c1923dd8cd8",
"1a44af1c-3e4c-4cd0-82fd-fe05e8035c0a",
"f4ba033e-8650-4714-bd3e-4771b839748c"
],
"charge_split_schema_uuid": "a62b2164-ee19-48da-bc14-175bdcb95215"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "b1312310-c782-4b6e-8ac4-a220661c5a1b",
"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": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+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_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_email": "#828994",
"portal_sidebar_account_title": "#11151D",
"portal_sidebar_button_active": "#FFFFFF",
"sidebar_title_secondary_hover": "#FFFFFF",
"portal_sidebar_collapse_button": "#828994",
"portal_sidebar_user_select_text": "#323B4B",
"portal_sidebar_button_background": "#F6F6F6",
"portal_sidebar_user_select_hover": "#F6F6F6",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "#F6F6F6",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border_hover": "#828994"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"cc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"bcc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"statement_frequency": "monthly",
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"keep_deleted_files_for": 30,
"reply_to_email_address": "jack@example.com",
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"mobile_app_support_email": "support@example.com",
"mobile_app_support_number": "01234 567890",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true
},
"name": "Gareth Thompson",
"role": "client",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "bc7641a9-c81e-4b19-a408-ad53250e342c",
"colour": "#ef4582",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00"
}
],
"type": "client",
"uuid": "652e291d-26bb-415d-bc8c-631efffb6303",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "1a6384c9-4d23-4d42-96c7-5dd04fc7169c",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "c80bd1f5-5f25-4321-a625-6b5a72d41f0c",
"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": "8e231126-db81-480d-bc1b-127bf50b6bac",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
}
],
"circles": [
{
"name": "Jones Family",
"uuid": "a26867d1-31f4-4b60-97b7-c934985ca24c",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\AccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"joint_account_uuid": "d621ff7b-7c78-4263-80f6-2170e921058b",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "6a7771fe-909e-425a-af9d-b57e604b471e",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+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": "382de2d8-d515-47dc-b678-f53b1e76f3b4",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "15c4c9b2-2ce9-443e-b3ab-7bbc3a57203f",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
},
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "ab547ee1-687a-4d06-99c6-fb9139560e71",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
},
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "ed732dfa-7be5-435d-b5cf-c30f62edf646",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2026-04-09T17:13:05+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2026-04-09T17:35:05+01:00",
"start_date": "2026-04-09T16:45:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"description": "This is a description.",
"trackable_type": "Client",
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680
},
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": [
{
"uuid": "ec2f82ef-889f-4b2a-9bdd-0b7ae69a8bae",
"reference": "AB123456",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"third_party": "nucleus"
}
],
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "bdb13658-280c-42b7-bd8d-7b6ac79cb8c9",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "da71dd15-08b1-44f8-8505-f3b5c9c471d8",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\AccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"joint_account_uuid": "2559eeae-b092-49f0-89c9-22ba043a223a",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "985540c3-720a-48cf-b5b1-e8fa75cb599f",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+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": "6830051a-7efc-46da-96b2-a03f6bff4606",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
},
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
}