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":"5a28deeb-5f44-4937-8cc5-6fe26389786a","groups":["afc4ecae-5f6c-4063-b501-7dac62b241bc","f4fa43ba-0242-427b-9eb3-02e9e77c219e"],"charge_split_schema_uuid":"228f0ec4-7ea7-4d43-aabd-5a15fb94062d"}'
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": "5a28deeb-5f44-4937-8cc5-6fe26389786a",
"groups": [
"afc4ecae-5f6c-4063-b501-7dac62b241bc",
"f4fa43ba-0242-427b-9eb3-02e9e77c219e"
],
"charge_split_schema_uuid": "228f0ec4-7ea7-4d43-aabd-5a15fb94062d"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "1c7f5eba-4064-4259-be8d-7a91d6abd822",
"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-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+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": "transparent",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "transparent",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border_hover": "#828994"
},
"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": "b5ce9f2a-2e57-470e-8556-6ec3aec9b309",
"colour": "#ef4582",
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+01:00"
}
],
"type": "client",
"uuid": "9858eb74-a962-460a-b92e-dce03174210d",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "1e4c3fcb-3898-4320-bd58-bb4c0264cf6b",
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "4ebf0690-f885-482a-bcfb-ec5bfef753e8",
"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": "61fd3fd9-0378-4a35-ac52-810f1bf51d76",
"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": "2025-10-08T10:40:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:15+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:15+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-10-08T10:40:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:15+01:00"
}
],
"circles": [
{
"name": "Jones Family",
"uuid": "dbd79d4b-b3ef-4e6e-bb1b-7235377a368c",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+01:00",
"joint_account_uuid": "5d439228-7440-46f0-a6cd-705da52a1785",
"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": "2025-10-08T10:40:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:15+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "bb672d1a-a910-44f8-8024-03d5a68d8e18",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+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": "f4c6e55e-4649-4fe8-b5fe-432a29a1cd4d",
"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": "2025-10-08T10:40:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:15+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:15+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-10-08T10:40:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:15+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "d354159e-92a9-43dc-9d30-dcdd23c7ae6b",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+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": "f745dcd8-f5ed-4766-a2db-28b3fcbcdc3f",
"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": "2025-10-08T10:40:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:15+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:15+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-10-08T10:40:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:15+01:00"
},
"next_review_date": "2025-10-08T10:40:15+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "bab02a23-47be-4dd9-b55a-fc1d517d4e35",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-10-08T10:18:15+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-10-08T10:40:15+01:00",
"start_date": "2025-10-08T09:50:15+01:00",
"updated_at": "2025-10-08T10:40:15+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-10-08T10:40:15+01:00",
"external_references": [
{
"uuid": "ea671ebe-5a21-43cd-b121-888a564c1e47",
"reference": "AB123456",
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+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": "b18e314f-62c8-4036-8f0a-520008da4cc4",
"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": "2025-10-08T10:40:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:15+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:15+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-10-08T10:40:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:15+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "f6b56a8d-8e06-4cca-89af-40701193d57f",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+01:00",
"joint_account_uuid": "eb3c2ad0-8a2a-427c-8a99-7ae8bb698e5b",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2025-10-08T10:40:15+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "e585f60f-a533-4a4d-b212-35ed8d4d2baf",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+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": "188f014d-7288-4d3d-8eb6-f1a933184b92",
"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": "2025-10-08T10:40:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:15+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:15+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-10-08T10:40:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:15+01:00"
},
"anniversary_review_date": "2025-10-08T10:40:15+01:00"
}