Headers
-
Content-Type
string -
Accept
string
Path parameters
-
firm_uuid
integer Required
Body
Required
-
keep_deleted_files_for
integer Number of days to keep files in the recycle bin. Set as null for indefinitely
-
tax
number Tax rate
-
rmar_start_date
date Date you will not be able to add charges before
-
advice_type
string Default RMAR advice type for new employees
-
month_end
integer Date of the month for the monthly income reconciliation statements to end. Leave at 31 for the end of the month
-
lock_statements_after
integer Automatically lock statements after number of days of statement end date. Leave null for never lock automatically. Zero for lock automatically immediately
-
adviser_split_uuid
string Default adviser split to be applied to new advisers
-
Whether to allow clients to view the pseudo folders in the client portal
-
fact_find_completed_notification_to_assigned_adviser
boolean Required Notify the assigned adviser when a client completes a fact find
-
fact_find_completed_notification_to_assigned_administrator
boolean Required Notify the assigned administrator when a client completes a fact find
-
fact_find_completed_notification_to_assigned_paraplanner
boolean Required Notify the assigned paraplanner when a client completes a fact find
-
charge_identifier
boolean Charge identifier to apply to charges. Visit support documentation for requirements and list of variables.
-
Notify the assigned adviser when a clients core details are updated.
-
Notify the assigned adviser when a clients core details are updated.
-
Notify the assigned adviser when a clients core details are updated.
-
Allow completion of cases with incomplete tasks.
POST
/api/v1/firm/{firm_uuid}/settings
curl \
--request POST 'https://api.plannrcrm.com/api/v1/firm/firm_uuid/settings' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data '{"keep_deleted_files_for":60,"tax":17.5,"rmar_start_date":"2022-08-01","advice_type":"independent","month_end":25,"lock_statements_after":0,"adviser_split_uuid":"a2f7121f-b326-4f4c-aa28-b7575c883b11","show_pseudo_folders_in_client_portal":true,"fact_find_completed_notification_to_assigned_adviser":true,"fact_find_completed_notification_to_assigned_administrator":true,"fact_find_completed_notification_to_assigned_paraplanner":true,"charge_identifier":true,"core_details_changed_notification_for_assigned_adviser":true,"core_details_changed_notification_for_assigned_administrator":true,"core_details_changed_notification_for_assigned_paraplanner":true,"allow_completion_of_cases_with_incomplete_tasks":true}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
# Payload
{
"keep_deleted_files_for": 60,
"tax": 17.5,
"rmar_start_date": "2022-08-01",
"advice_type": "independent",
"month_end": 25,
"lock_statements_after": 0,
"adviser_split_uuid": "a2f7121f-b326-4f4c-aa28-b7575c883b11",
"show_pseudo_folders_in_client_portal": true,
"fact_find_completed_notification_to_assigned_adviser": true,
"fact_find_completed_notification_to_assigned_administrator": true,
"fact_find_completed_notification_to_assigned_paraplanner": true,
"charge_identifier": true,
"core_details_changed_notification_for_assigned_adviser": true,
"core_details_changed_notification_for_assigned_administrator": true,
"core_details_changed_notification_for_assigned_paraplanner": true,
"allow_completion_of_cases_with_incomplete_tasks": true
}
Response examples (200)
{
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "d2cff1a6-d303-4637-a8ff-7147a17351a1",
"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-04-22T13:44:16+01:00",
"updated_at": "2025-04-22T13:44:16+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",
"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": [
{
"uuid": "de238c66-c2fd-41c8-a8c8-263a4c9a596d",
"addon": "App\\Http\\Resources\\Addons\\AddonResource",
"enabled": "true",
"created_at": "2025-04-22T13:44:16+01:00",
"updated_at": "2025-04-22T13:44:16+01:00"
}
],
"statement_frequency": "monthly",
"task_board_template": {
"name": "Task Board",
"uuid": "10075c7b-5fe7-4887-8d85-45eab95bdf5f",
"lists": "App\\Http\\Resources\\Board\\BoardListResource",
"modelable": "App\\Http\\Resources\\CasesResource",
"created_at": "2025-04-22T13:44:16+01:00",
"priorities": [
{
"name": "High",
"value": "high"
},
{
"name": "Low",
"value": "low"
}
],
"updated_at": "2025-04-22T13:44:16+01:00",
"is_editable": true,
"is_template": false,
"default_list_uuid": "a3f22d8c-620a-40d4-8039-174fddedd75f"
},
"keep_deleted_files_for": 30,
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true
}