Update firm branding

POST /api/v1/firm/{firm_uuid}/branding

Personal access token & O auth2

Headers

Authorization string
Content-Type string
Accept string

Path parameters

firm_uuid integer Required

application/json

Body

brand_colours array[string]

Array of hex colours values for your branding.
logo string

Image file of your logo. Max 10MB
logo_icon string

Image file of your logo icon. Max 10MB, Width and Height: Min 50px Max 150px. Aspect Ratio 1/1
banner string

Image file of your banner. Max 25MB
branded_auth_background string

Image file for the branded authentication background. Used on your branded login page. Max 25MB
use_branded_auth boolean

Controls if the firm's branded authentication pages will work. When enabled, users will also be automatically redirected to the branded login page.
welcome_paragraph_html string

Custom welcome paragraph html for the branded auth welcome page.. Can add basic variables for firm,first_name,last_name.
email_welcome_paragraph_html string

Custom welcome paragraph for the welcome/new user email. Can add basic variables for firm,first_name,last_name.
show_fact_find_illustrations boolean

Determines if the illustrations/graphics are displayed on the fact-find.

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  Name of the firm
- slug string
  
  Slug of the firm
- address_1 string
  
  First line of the address
- address_2 string
  
  Second line of the address
- town_city string
  
  Town/City
- county string
  
  County
- postcode string
  
  Postcode
- country string
  
  Country
- regulatory_text string
  
  Regulatory text of the firm.
- logo string
  
  URL of your firm logo.
- logo_icon string
  
  URL of your firm logo icon.
- brand_colours object
  
  Firm branding colours.
- is_subscribed boolean
  
  Subscription status.
- addon_subscriptions array[object]
  
  All addons the firm is subscribed to.
- keep_deleted_files_for integer
  
  Number of days to keep deleted files for
- tax number
  
  Tax percent
- month_end integer
  
  Date of the month for the monthly income reconciliation statements to end
- statement_frequency string
  
  The frequency of the income reconciliation statements
- billing object
  
  Firm invoice details for billing
- task_board_template object
  
  The task board template that is used when every client or case is created
- ip_whitelist array[string]
  
  A list of IP Addresses a firm is allowed to log in from.
- welcome_paragraph_html string
  
  Custom welcome paragraph html for the branded auth welcome page
- email_welcome_paragraph_html string
  
  Custom welcome paragraph for the welcome/new user email
- show_fact_find_illustrations boolean
  
  Determines if the illustrations/graphics are displayed on the fact-find.

POST /api/v1/firm/{firm_uuid}/branding

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/firm/firm_uuid/branding' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"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"}],"logo":"Logo.png","logo_icon":"Logo-icon.png","banner":"Banner.png","branded_auth_background":"BrandedAuthBackground.png","use_branded_auth":true,"welcome_paragraph_html":"\u003ch1\u003eWelcome to {{ firm }} {{ first_name }}\u003c/h1\u003e","email_welcome_paragraph_html":"\u003cp\u003eHello {{ first_name }}, you have been invited to our portal at {{ firm }}.\u003c/p\u003e","show_fact_find_illustrations":true}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "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"
    }
  ],
  "logo": "Logo.png",
  "logo_icon": "Logo-icon.png",
  "banner": "Banner.png",
  "branded_auth_background": "BrandedAuthBackground.png",
  "use_branded_auth": true,
  "welcome_paragraph_html": "<h1>Welcome to {{ firm }} {{ first_name }}</h1>",
  "email_welcome_paragraph_html": "<p>Hello {{ first_name }}, you have been invited to our portal at {{ firm }}.</p>",
  "show_fact_find_illustrations": true
}

Response examples (200)

{
  "tax": 17.5,
  "logo": "https://api.plannrcrm.com/images/plannr.jpg",
  "name": "Codepotato",
  "slug": "codepotato",
  "uuid": "e5377c72-8098-41f9-a4c8-6dc1f3d4ef5c",
  "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-06-13T16:58:54+01:00",
  "updated_at": "2025-06-13T16:58:54+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": [
    {
      "uuid": "6cf01a40-466e-42f3-9871-56c369e0870a",
      "addon": "App\\Http\\Resources\\Addons\\AddonResource",
      "enabled": "true",
      "created_at": "2025-06-13T16:58:54+01:00",
      "updated_at": "2025-06-13T16:58:54+01:00"
    }
  ],
  "statement_frequency": "monthly",
  "task_board_template": {
    "name": "Task Board",
    "uuid": "a24b4ace-fa45-4bf2-bdc7-5746e7cbded6",
    "lists": "App\\Http\\Resources\\Board\\BoardListResource",
    "modelable": "App\\Http\\Resources\\CasesResource",
    "created_at": "2025-06-13T16:58:54+01:00",
    "priorities": [
      {
        "name": "High",
        "value": "high"
      },
      {
        "name": "Low",
        "value": "low"
      }
    ],
    "updated_at": "2025-06-13T16:58:54+01:00",
    "is_editable": true,
    "is_template": false,
    "default_list_uuid": "28b9d4e5-eb9b-4297-9893-e05f0b86b5fa"
  },
  "keep_deleted_files_for": 30,
  "welcome_paragraph_html": "<h1>Welcome.</h1>",
  "email_welcome_paragraph_html": "Welcome to Plannr!",
  "show_fact_find_illustrations": true
}