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":"2519f7a9-7d22-4a99-81d3-687b2021adb7","groups":["7b7465ac-1bf8-4478-864b-52fadc3939c8","4f4b0cc0-3407-43c4-95d5-22c5727bb7c9"],"charge_split_schema_uuid":"e136991c-eea1-4c83-83f4-df95bc7bf022"}'
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": "2519f7a9-7d22-4a99-81d3-687b2021adb7",
"groups": [
"7b7465ac-1bf8-4478-864b-52fadc3939c8",
"4f4b0cc0-3407-43c4-95d5-22c5727bb7c9"
],
"charge_split_schema_uuid": "e136991c-eea1-4c83-83f4-df95bc7bf022"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "f1eb277a-2fd8-45a6-9883-706dc2811da9",
"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-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+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_account_email": "#828994",
"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_title": "#11151d",
"portal_sidebar_button_active": "#ffffff",
"sidebar_title_secondary_hover": "#ffffff",
"portal_sidebar_button_background": "#f6f6f6"
},
"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": "ed62c44c-6b48-4562-ba6e-b9122b6af165",
"colour": "#ef4582",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+01:00"
}
],
"type": "client",
"uuid": "381700fb-03e1-410e-a936-19ddd236a7ce",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "71cf667b-9a5c-493c-a173-90a1db25082c",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "ff3dda7a-0e1b-49a1-b8dc-3b0daf5079b5",
"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": "4b622e25-20bd-4ffa-a828-e7ea4d49e074",
"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-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
}
],
"circles": [
{
"name": "Jones Family",
"uuid": "d595c8a6-7f70-4089-89fd-83b139de61cd",
"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-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+01:00",
"joint_account_uuid": "71495a96-6a62-4361-a988-5d571e2839b0",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "3996a661-048f-4bb0-9b2e-b579ef088c2f",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+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": "9a4f1805-c92d-4e2b-a337-34d699aa9079",
"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-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "d79f1379-4d82-4d59-a819-efeb520c76fb",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+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": "81a7cadc-9374-45ec-88d4-9b6c71adb26c",
"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-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
},
"next_review_date": "2025-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "bcfab705-1f5e-4d77-9465-a6ff21406529",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-08-07T13:19:40+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-08-07T13:41:40+01:00",
"start_date": "2025-08-07T12:51:40+01:00",
"updated_at": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"external_references": [
{
"uuid": "6c9ddbe2-f378-4f2c-ab61-ec1e42731d8e",
"reference": "AB123456",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+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": "fd8d096f-24c6-4663-a8c9-818e063db7d2",
"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-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "589b22dd-ef38-4d6a-bb4e-587bd28f7657",
"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-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+01:00",
"joint_account_uuid": "4ad67b48-1241-4d1b-9ec4-29e605b91e3e",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2025-08-07T13:41:40+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "279c3065-fad3-4af6-8cdb-0fa9c123fe70",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+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": "9359f2e4-cc65-46fc-948a-05d3fbd60755",
"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-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
},
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
}