---
title: "PATCH /v2/settings/brands/{brand-id}"
method: PATCH
path: "/v2/settings/brands/{brand-id}"
tags: ["Brands Api Service"]
---

# PATCH /v2/settings/brands/{brand-id}

`PATCH /v2/settings/brands/{brand-id}`

## Request

- Base URL: `https://app.metricool.com/api`
- URL: `https://app.metricool.com/api/v2/settings/brands/{brand-id}`
- Auth: none declared

## Path parameters

- `brand-id` integer, required

## Query parameters

- `fields` string[], required

## Request body

- Brand
  - `id` integer
  - `userId` integer
  - `ownerUserId` integer
  - `label` string
  - `title` string
  - `description` string
  - `image` string
  - `imageSource` 'CUSTOM' | 'NETWORK' | 'DEFAULT': Where the image the brand renders comes from. Always present on a brand response.
  - `networksData` NetworksData
    - `webData` string
    - `facebookData` string
    - `instagramData` string
    - `threadsData` string
    - `blueskyData` string
    - `twitterData` string
    - `linkedinData` string
    - `pinterestData` string
    - `tiktokData` string
    - `gbpData` string
    - `youtubeData` string
    - `twitchData` string
    - `facebookAdsData` string
    - `googleAdsData` string
    - `tiktokAdsData` string
  - `isShared` boolean
  - `ownerUsername` string
  - `whiteLabelData` WhiteLabelData
    - `whiteLabelLink` string
    - `analyticModeWhitelabelLink` string
    - `whiteLabelAlias` string
    - `isWhiteLabel` boolean
    - `isWhiteLabelOnlyRead` boolean
  - `hash` string
  - `version` integer
  - `deleteDate` DateTimeInfo
    - `dateTime` string, required: Local Date-time represented with a certain timezone
    - `timezone` string: Timezone applied to the datetime
  - `deleted` boolean
  - `joinDate` DateTimeInfo
    - `dateTime` string, required: Local Date-time represented with a certain timezone
    - `timezone` string: Timezone applied to the datetime
  - `firstConnectionDate` DateTimeInfo
    - `dateTime` string, required: Local Date-time represented with a certain timezone
    - `timezone` string: Timezone applied to the datetime
  - `lastResolvedInboxMessageTimestamp` integer
  - `lastReadInboxMessageTimestamp` integer
  - `timezone` string
  - `availableConnectors` string[]
  - `brandRole` BrandRole
    - `id` integer
    - `userId` integer, required
    - `name` string, required
    - `description` string
    - `color` string
    - `type` string
    - `assignable` boolean
    - `teamMemberOnly` boolean
    - `deletedDate` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `deleted` boolean
    - `actions` BrandRoleActions, required
      - `viewAnalytics` boolean
      - `viewInbox` boolean
      - `viewPlanner` boolean
      - `viewAds` boolean
      - `viewSmartlinks` boolean
      - `fullAccessReports` boolean
      - `fullAccessInbox` boolean
      - `fullAccessPlanner` boolean
      - `fullAccessAds` boolean
      - `fullAccessSmartlinks` boolean
      - `fullAccessHashtagTracker` boolean
      - `editBrand` boolean
      - `schedulePosts` boolean
      - `publishPosts` boolean
      - `approvePosts` boolean
      - `viewCondensedAnalytics` boolean
      - `fullAccessDashboards` boolean
      - `viewDashboards` boolean
      - `editFlow` boolean
      - `viewFlow` boolean
      - `fullAccessStudio` boolean
    - `organizationActions` OrganizationRoleActionsDto, required: Organization-level permissions granted by a brand role, on top of the per-brand actions. Never null in a read response - a role that never had organization permissions set is reported with every field false.
      - `manageBrands` boolean: Whether the role can create and manage brands at the organization level.
      - `manageRoles` boolean: Whether the role can create and manage other brand roles at the organization level.
      - `manageTeamMembers` boolean: Whether the role can manage team members at the organization level.
      - `manageAgencyConfig` boolean: Whether the role can manage the agency configuration.
      - `manageAgencyClients` boolean: Whether the role can manage agency clients.
    - `assignedUsersCount` integer
    - `assignedEnabledCount` integer
    - `assignedDisabledCount` integer
  - `isDemo` boolean
  - `properties` BrandProperties
    - `customEmail` string
    - `additionalNotificationAddresses` string[]
    - `colors` Colors
      - `blue` string
      - `teal` string
      - `pink` string
      - `yellow` string
      - `purple` string
      - `cyan` string
      - `red` string
      - `green` string
      - `slate` string
      - `charcoal` string
      - `lightYellow` string
      - `darkYellow` string
      - `cobalt` string
    - `trialExcluded` string
    - `engagementRatio` integer

## Response `200`

OK

- JsonOkResponseBrand
  - `metadata` object
  - `page` JsonPaging
    - `next` string
  - `data` Brand
    - `id` integer
    - `userId` integer
    - `ownerUserId` integer
    - `label` string
    - `title` string
    - `description` string
    - `image` string
    - `imageSource` 'CUSTOM' | 'NETWORK' | 'DEFAULT': Where the image the brand renders comes from. Always present on a brand response.
    - `networksData` NetworksData
      - `webData` string
      - `facebookData` string
      - `instagramData` string
      - `threadsData` string
      - `blueskyData` string
      - `twitterData` string
      - `linkedinData` string
      - `pinterestData` string
      - `tiktokData` string
      - `gbpData` string
      - `youtubeData` string
      - `twitchData` string
      - `facebookAdsData` string
      - `googleAdsData` string
      - `tiktokAdsData` string
    - `isShared` boolean
    - `ownerUsername` string
    - `whiteLabelData` WhiteLabelData
      - `whiteLabelLink` string
      - `analyticModeWhitelabelLink` string
      - `whiteLabelAlias` string
      - `isWhiteLabel` boolean
      - `isWhiteLabelOnlyRead` boolean
    - `hash` string
    - `version` integer
    - `deleteDate` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `deleted` boolean
    - `joinDate` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `firstConnectionDate` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `lastResolvedInboxMessageTimestamp` integer
    - `lastReadInboxMessageTimestamp` integer
    - `timezone` string
    - `availableConnectors` string[]
    - `brandRole` BrandRole
      - `id` integer
      - `userId` integer, required
      - `name` string, required
      - `description` string
      - `color` string
      - `type` string
      - `assignable` boolean
      - `teamMemberOnly` boolean
      - `deletedDate` DateTimeInfo
        - `dateTime` string, required: Local Date-time represented with a certain timezone
        - `timezone` string: Timezone applied to the datetime
      - `deleted` boolean
      - `actions` BrandRoleActions, required
        - `viewAnalytics` boolean
        - `viewInbox` boolean
        - `viewPlanner` boolean
        - `viewAds` boolean
        - `viewSmartlinks` boolean
        - `fullAccessReports` boolean
        - `fullAccessInbox` boolean
        - `fullAccessPlanner` boolean
        - `fullAccessAds` boolean
        - `fullAccessSmartlinks` boolean
        - `fullAccessHashtagTracker` boolean
        - `editBrand` boolean
        - `schedulePosts` boolean
        - `publishPosts` boolean
        - `approvePosts` boolean
        - `viewCondensedAnalytics` boolean
        - `fullAccessDashboards` boolean
        - `viewDashboards` boolean
        - `editFlow` boolean
        - `viewFlow` boolean
        - `fullAccessStudio` boolean
      - `organizationActions` OrganizationRoleActionsDto, required: Organization-level permissions granted by a brand role, on top of the per-brand actions. Never null in a read response - a role that never had organization permissions set is reported with every field false.
        - `manageBrands` boolean: Whether the role can create and manage brands at the organization level.
        - `manageRoles` boolean: Whether the role can create and manage other brand roles at the organization level.
        - `manageTeamMembers` boolean: Whether the role can manage team members at the organization level.
        - `manageAgencyConfig` boolean: Whether the role can manage the agency configuration.
        - `manageAgencyClients` boolean: Whether the role can manage agency clients.
      - `assignedUsersCount` integer
      - `assignedEnabledCount` integer
      - `assignedDisabledCount` integer
    - `isDemo` boolean
    - `properties` BrandProperties
      - `customEmail` string
      - `additionalNotificationAddresses` string[]
      - `colors` Colors
        - `blue` string
        - `teal` string
        - `pink` string
        - `yellow` string
        - `purple` string
        - `cyan` string
        - `red` string
        - `green` string
        - `slate` string
        - `charcoal` string
        - `lightYellow` string
        - `darkYellow` string
        - `cobalt` string
      - `trialExcluded` string
      - `engagementRatio` integer

---

[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/e80d55f71a08?raw)