Update an introducer [Deprecated: Use update an account route]
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body
-
title string
Title
-
first_name string
First name
-
last_name string
Last name
-
entity_name string
Entity/business name
-
assigned_adviser_uuid string
UUID of the account that this account reports to
-
charge_split_schema_uuid string
Charge split schema that is always used when adding a charge split for this introducer
-
groups array[string]
Group UUIDs to sync introducer to. Null can be provided to clear an introducers groups
PUT
/api/v1/introducer/{uuid}
curl \
-X PUT https://api.plannrcrm.com/api/v1/introducer/uuid \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
-d '{"title":"Mr","first_name":"Patrick","last_name":"Stanton","entity_name":"PatrickCo","assigned_adviser_uuid":"50278f5d-db6d-484d-8e9e-c0d78ee1a6a6","charge_split_schema_uuid":"d741cc83-6d22-4d2c-b4c6-7798f519ce89","groups":["e9d55739-8919-4178-a237-220912972816","311fa448-2f8c-45af-b614-e0b88b7ac516"]}'
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",
"assigned_adviser_uuid": "50278f5d-db6d-484d-8e9e-c0d78ee1a6a6",
"charge_split_schema_uuid": "d741cc83-6d22-4d2c-b4c6-7798f519ce89",
"groups": [
"e9d55739-8919-4178-a237-220912972816",
"311fa448-2f8c-45af-b614-e0b88b7ac516"
]
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "e1172806-0711-42b1-b2a2-fa3dc7556e91",
"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-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00: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!"
},
"name": "Gareth Thompson",
"role": "client",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "ee282a70-6cbd-4eb2-a972-8f5a4eee5f25",
"colour": "#ef4582",
"created_at": "2025-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00:00"
}
],
"type": "client",
"uuid": "b2fa5b4d-ea53-4e63-ae7d-e895e4c4495e",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "bf8c06c8-7734-447d-aec5-1948223f43ff",
"created_at": "2025-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "69688fc7-d68c-4409-8c09-21f326ad4e1a",
"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": "bb0a471c-b591-4d9a-8750-86de4650ad5e",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-20T22:37:17+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-20T22:37:17+00:00",
"with_login": true,
"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-01-20T22:37:17+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-20T22:37:17+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-20T22:37:17+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-20T22:37:17+00:00"
}
],
"last_name": "Thompson",
"created_at": "2025-01-20T22:37:17+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-20T22:37:17+00:00",
"with_login": true,
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "d10efe04-9bd6-4525-a568-06f4cc28c88d",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00: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": "1c359d21-9f51-48ea-9444-59e56dffebdc",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-20T22:37:17+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-20T22:37:17+00:00",
"with_login": true,
"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-01-20T22:37:17+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-20T22:37:17+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-20T22:37:17+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-20T22:37:17+00:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "1520a3b7-bdb4-4a22-abf3-6f374310ffd8",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00: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": "55c80ffb-a5f4-4383-a1c3-9d478c264085",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-20T22:37:17+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-20T22:37:17+00:00",
"with_login": true,
"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-01-20T22:37:17+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-20T22:37:17+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-20T22:37:17+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-20T22:37:17+00:00"
},
"next_review_date": "2025-01-20T22:37:17+00:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "66d6d592-86ac-41b0-ae9e-3722cfc76ee5",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-01-20T22:15:17+00:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-01-20T22:37:17+00:00",
"start_date": "2025-01-20T21:47:17+00:00",
"updated_at": "2025-01-20T22:37:17+00:00",
"description": "This is a description.",
"trackable_type": "Client",
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680
},
"first_contact_date": "2025-01-20T22:37:17+00:00",
"external_references": [
{
"uuid": "8bda248d-115e-4351-9959-568b6ed7292e",
"reference": "AB123456",
"created_at": "2025-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00:00",
"third_party": "nucleus"
}
],
"assigned_paraplanner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "17d60e34-30f9-4d97-91c7-4eb189f8bc00",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-20T22:37:17+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-20T22:37:17+00:00",
"with_login": true,
"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-01-20T22:37:17+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-20T22:37:17+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-20T22:37:17+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-20T22:37:17+00:00"
},
"previous_review_date": "2025-01-20T22:37:17+00:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "695455c6-edf6-4c9c-ac63-692ea0cf712e",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00: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": "af76ede3-6692-49d2-a622-f232ee59639e",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-20T22:37:17+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-20T22:37:17+00:00",
"with_login": true,
"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-01-20T22:37:17+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-20T22:37:17+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-20T22:37:17+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-20T22:37:17+00:00"
},
"anniversary_review_date": "2025-01-20T22:37:17+00:00"
}