Body
Required
-
The first name of the employee.
-
The last name of the employee.
-
The email of the employee. Required when with_login is present.
-
Denotes if the employee needs a billable login.
-
The uuid of the senior employee that the employee directly reports to
-
The role of the employee.
-
The departments the employee is part of
-
Adviser split
-
Group UUIDs to sync employee to. Null can be provided to clear an employees groups
-
Employee's RMAR advice type
PUT
/api/v1/employee/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/employee/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"first_name":"Gareth","last_name":"Thompson","email":"gareth.thompson@plannrcrm.com","with_login":true,"assigned_adviser_uuid":"e084be63-037e-45a2-afe4-77a11307e6c2","role":"owner","departments":["paraplanner","adviser"],"adviser_split_uuid":"5926bedb-dc2e-4781-be19-97f2e536f381","groups":["41516562-f06b-47cf-9069-99f680cdf80d","95425df5-b98b-44c1-9210-88e13e0bfc5b"],"advice_type":"independent"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"first_name": "Gareth",
"last_name": "Thompson",
"email": "gareth.thompson@plannrcrm.com",
"with_login": true,
"assigned_adviser_uuid": "e084be63-037e-45a2-afe4-77a11307e6c2",
"role": "owner",
"departments": [
"paraplanner",
"adviser"
],
"adviser_split_uuid": "5926bedb-dc2e-4781-be19-97f2e536f381",
"groups": [
"41516562-f06b-47cf-9069-99f680cdf80d",
"95425df5-b98b-44c1-9210-88e13e0bfc5b"
],
"advice_type": "independent"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "390d2e0d-5d69-48d2-880a-3c1c71cfcce6",
"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-07-17T16:23:19+01:00",
"updated_at": "2025-07-17T16:23:19+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": "01d66891-b623-458b-bb76-e76417c20eec",
"colour": "#ef4582",
"created_at": "2025-07-17T16:23:19+01:00",
"updated_at": "2025-07-17T16:23:19+01:00"
}
],
"type": "client",
"uuid": "fa464437-8158-4bf7-a10e-ae6244733ac3",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "a10f5e8e-77b0-4f2f-b3fa-65a057a5b723",
"created_at": "2025-07-17T16:23:19+01:00",
"updated_at": "2025-07-17T16:23:19+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "ac82937d-a825-4455-b862-b56700f91484",
"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": "f13f5cc8-9da9-45ca-bcd6-059a9287187b",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:19+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:19+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:19+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:19+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-07-17T16:23:19+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:19+01:00"
}
],
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:19+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:19+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "b612d163-23ef-4e6c-988f-4276dbdd6fda",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-07-17T16:23:19+01:00",
"updated_at": "2025-07-17T16:23:19+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": "0c2adafa-d245-4b1e-9b03-cf608f414346",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:19+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:19+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:19+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:19+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-07-17T16:23:19+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:19+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "0f535a7e-7ee5-4bfe-99bc-c41c1bb83dbc",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-07-17T16:23:19+01:00",
"updated_at": "2025-07-17T16:23:19+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": "7ee8203a-d64a-42b4-986b-e84bf8f63296",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:19+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:19+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:19+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:19+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-07-17T16:23:19+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:19+01:00"
},
"next_review_date": "2025-07-17T16:23:19+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "39875278-e1f3-414d-a399-7fdc86edef85",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-07-17T16:01:19+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-07-17T16:23:19+01:00",
"start_date": "2025-07-17T15:33:19+01:00",
"updated_at": "2025-07-17T16:23:19+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-07-17T16:23:19+01:00",
"external_references": [
{
"uuid": "2449da1d-3ee4-43cf-a026-25daaec0eafb",
"reference": "AB123456",
"created_at": "2025-07-17T16:23:19+01:00",
"updated_at": "2025-07-17T16:23:19+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": "9a0bde4a-2a48-4333-b55b-b6c4b74f0e9a",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:19+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:19+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:19+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:19+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-07-17T16:23:19+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:19+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "3300d98a-a1a7-442d-8715-a5f7158d2511",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-07-17T16:23:19+01:00",
"updated_at": "2025-07-17T16:23:19+01:00",
"joint_account_uuid": "8357cb58-a37f-41eb-9e05-3c4f586a0558",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2025-07-17T16:23:19+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "6c0867e5-2ddb-470d-a4e1-a92f7966818f",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-07-17T16:23:19+01:00",
"updated_at": "2025-07-17T16:23:19+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": "aaba4406-f6ff-4b13-9b46-96c7399d6e2e",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:19+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:19+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:19+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:19+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-07-17T16:23:19+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:19+01:00"
},
"anniversary_review_date": "2025-07-17T16:23:19+01:00"
}