---
title: "Edit Agency configuration properties"
method: PATCH
path: "/v2/agency-CK/{agencyId}/properties"
tags: ["Agency Customization Kit Api Service"]
---

# Edit Agency configuration properties

`PATCH /v2/agency-CK/{agencyId}/properties`

## Request

- Base URL: `https://app.metricool.com/api`
- URL: `https://app.metricool.com/api/v2/agency-CK/{agencyId}/properties`
- Auth: none declared

## Path parameters

- `agencyId` integer, required

## Query parameters

- `fields` string[], required

## Request body

- AgencyPropertiesForUpdateDto
  - `agencyLogo` string
  - `loginLogo` string
  - `faviconLogo` string
  - `supportChat` boolean
  - `helpArticles` boolean
  - `colorPalette` ColorsDto: Chart colors, always the 13 of them (Metricool defaults where not customized).
    - `blue` string, required
    - `teal` string, required
    - `pink` string, required
    - `yellow` string, required
    - `lightYellow` string, required
    - `darkYellow` string, required
    - `purple` string, required
    - `cyan` string, required
    - `red` string, required
    - `green` string, required
    - `slate` string, required
    - `charcoal` string, required
    - `cobalt` string, required
  - `reportLogo` string
  - `mailMessage` string
  - `mailReplyTo` string
  - `mailLogo` string
  - `themeColorPalette` ThemeColorsDto: Optional white-label theme colors. Each field accepts a hex color (#RGB/#RRGGBB, alpha variants #RGBA/#RRGGBBAA included) or the literal 'transparent'. A field left null/blank falls back to the Metricool default when the color has never been customized; in a PATCH that only updates some of the 10 fields, a null/blank field instead keeps whatever was already saved for it - only sending the whole themeColorPalette object as null resets every color back to the default at once.
    - `topMenuBackgroundColor` string: Top menu background color
    - `topMenuTextColor` string: Top menu text color
    - `topMenuSeparatorColor` string: Top menu separator color
    - `primaryButtonBackgroundColor` string: Primary button background color
    - `primaryButtonBorderColor` string: Primary button border color
    - `primaryButtonTextColor` string: Primary button text color
    - `secondaryButtonBackgroundColor` string: Secondary button background color
    - `secondaryButtonBorderColor` string: Secondary button border color
    - `secondaryButtonTextColor` string: Secondary button text color
    - `backgroundColor` string: General background color
    - `customizedColors` string[]: Names of the fields above that were actually customized, in the same order as the fields themselves. Any field not listed here is equal to the Metricool default - a frontend rendering per-screen defaults should only apply the fields listed here and leave the rest untouched.

## Response `200`

OK

- JsonOkResponseAgencyPropertiesForUpdateDto
  - `metadata` object
  - `page` JsonPaging
    - `next` string
  - `data` AgencyPropertiesForUpdateDto
    - `agencyLogo` string
    - `loginLogo` string
    - `faviconLogo` string
    - `supportChat` boolean
    - `helpArticles` boolean
    - `colorPalette` ColorsDto: Chart colors, always the 13 of them (Metricool defaults where not customized).
      - `blue` string, required
      - `teal` string, required
      - `pink` string, required
      - `yellow` string, required
      - `lightYellow` string, required
      - `darkYellow` string, required
      - `purple` string, required
      - `cyan` string, required
      - `red` string, required
      - `green` string, required
      - `slate` string, required
      - `charcoal` string, required
      - `cobalt` string, required
    - `reportLogo` string
    - `mailMessage` string
    - `mailReplyTo` string
    - `mailLogo` string
    - `themeColorPalette` ThemeColorsDto: Optional white-label theme colors. Each field accepts a hex color (#RGB/#RRGGBB, alpha variants #RGBA/#RRGGBBAA included) or the literal 'transparent'. A field left null/blank falls back to the Metricool default when the color has never been customized; in a PATCH that only updates some of the 10 fields, a null/blank field instead keeps whatever was already saved for it - only sending the whole themeColorPalette object as null resets every color back to the default at once.
      - `topMenuBackgroundColor` string: Top menu background color
      - `topMenuTextColor` string: Top menu text color
      - `topMenuSeparatorColor` string: Top menu separator color
      - `primaryButtonBackgroundColor` string: Primary button background color
      - `primaryButtonBorderColor` string: Primary button border color
      - `primaryButtonTextColor` string: Primary button text color
      - `secondaryButtonBackgroundColor` string: Secondary button background color
      - `secondaryButtonBorderColor` string: Secondary button border color
      - `secondaryButtonTextColor` string: Secondary button text color
      - `backgroundColor` string: General background color
      - `customizedColors` string[]: Names of the fields above that were actually customized, in the same order as the fields themselves. Any field not listed here is equal to the Metricool default - a frontend rendering per-screen defaults should only apply the fields listed here and leave the rest untouched.

---

[API](https://skmtc.dev/metricool/apis/metricool-api.md) · [All operations](https://skmtc.dev/metricool/apis/metricool-api/llms.txt) · [OpenAPI document](https://skmtc.dev/metricool/apis/metricool-api/revisions/cd0ca612fa01?raw)