Update firm branding

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

Headers

Path parameters

application/json

Body

  • brand_colours array[string]

    Array of hex colours values for your branding.

  • 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.

Responses

POST /api/v1/firm/{firm_uuid}/branding 
curl \
 -X POST https://api.plannrcrm.com/api/v1/firm/firm_uuid/branding \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"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"}],"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"}'
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",
      "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"
    }
  ],
  "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>"
}
Response examples (200) 
{
  "tax": 17.5,
  "logo": "https://api.plannrcrm.com/images/plannr.jpg",
  "name": "Codepotato",
  "slug": "codepotato",
  "uuid": "fdadfa22-011c-4d2d-8580-bd525e36b646",
  "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": "2024-11-20T13:23:59+00:00",
  "updated_at": "2024-11-20T13:23:59+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": [
    {
      "uuid": "ec3133be-0ee7-4fc1-bc80-b6a4207849ba",
      "addon": "App\\Http\\Resources\\Addons\\AddonResource",
      "enabled": "true",
      "created_at": "2024-11-20T13:23:59+00:00",
      "updated_at": "2024-11-20T13:23:59+00:00"
    }
  ],
  "statement_frequency": "monthly",
  "task_board_template": {
    "name": "Task Board",
    "uuid": "97fc4684-f322-4bec-9c5a-0ceaa3db5571",
    "lists": "App\\Http\\Resources\\Board\\BoardListResource",
    "modelable": "App\\Http\\Resources\\CasesResource",
    "created_at": "2024-11-20T13:23:59+00:00",
    "priorities": [
      {
        "name": "High",
        "value": "high"
      },
      {
        "name": "Low",
        "value": "low"
      }
    ],
    "updated_at": "2024-11-20T13:23:59+00:00",
    "is_editable": true,
    "is_template": false,
    "default_list_uuid": "34f145f4-d93b-4d42-b043-e4e3ed7eba7d"
  },
  "keep_deleted_files_for": 30,
  "welcome_paragraph_html": "<h1>Welcome.</h1>",
  "email_welcome_paragraph_html": "Welcome to Plannr!"
}