# Update firm branding

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




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters

### Path parameters
- **firm_uuid** (string)



### Body: application/json (object)

- **brand_colours** (array)
  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


#### Body: application/json (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.
- **cc_email_addresses** (array[string])
  Array of email cc addresses.
- **bcc_email_addresses** (array[string])
  Array of email bcc addresses.
- **reply_to_email_address** (string)
  Firm reply to email address.


[Powered by Bump.sh](https://bump.sh)