Metricool Whitelabel Settings Api Service API

openapi: 3.2.0
info:
  title: Metricool Whitelabel Settings Api Service API
  description: 'Metricool API


    The base URL for all endpoints is: https://app.metricool.com/api


    All endpoints require authentication.'
  version: 2.0.0
servers:
- url: https://app.metricool.com/api
tags:
- name: Whitelabel Settings Api Service
paths:
  /v2/settings/whitelabel/customization:
    get:
      tags:
      - Whitelabel Settings Api Service
      summary: Get the white label theme and chart colors of the authenticated owner
      operationId: getCustomization
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseWhitelabelCustomizationDto'
        '403':
          description: Not a white label owner, or the customization is not enabled for this account
    patch:
      tags:
      - Whitelabel Settings Api Service
      summary: Update the white label theme and/or chart colors of the authenticated owner
      description: Only the fields listed in 'fields' are applied. themeColorPalette merges the colors present in the request onto whatever is already saved (Metricool defaults for anything never customized); sending the whole themeColorPalette object as null resets it back to Metricool defaults. colors must always carry the complete 13 chart colors and cannot be sent as null.
      operationId: updateCustomization
      parameters:
      - name: fields
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WhitelabelCustomizationUpdateDto'
        required: true
      responses:
        '200':
          description: Updated customization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseWhitelabelCustomizationDto'
        '400':
          description: Unknown field, invalid color, or colors sent as null
        '403':
          description: Not a white label owner, or the customization is not enabled for this account
  /v2/settings/whitelabel/logininfo/{blogId}:
    get:
      tags:
      - Whitelabel Settings Api Service
      operationId: getToken
      parameters:
      - name: scope
        in: query
        required: false
        schema:
          type: string
      - name: expm
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: networks
        in: query
        required: false
        schema:
          type: string
      - name: role
        in: query
        required: false
        schema:
          type: string
      - name: blogId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: redirect
        in: query
        required: false
        schema:
          type: string
      - name: dlprop
        in: query
        required: false
        schema:
          type: string
      - name: lang
        in: query
        required: false
        schema:
          type: string
      - name: weekStartsOn
        in: query
        required: false
        schema:
          type: string
      - name: email
        in: query
        required: false
        schema:
          type: string
      - name: notificationAddresses
        in: query
        required: false
        schema:
          type: string
      - name: singleUse
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseLoginInfo'
      summary: Get token
      x-summary-source: derived
components:
  schemas:
    JsonOkResponseWhitelabelCustomizationDto:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          $ref: '#/components/schemas/WhitelabelCustomizationDto'
    WhitelabelCustomizationDto:
      type: object
      properties:
        themeColorPalette:
          $ref: '#/components/schemas/ThemeColorsDto'
        colors:
          $ref: '#/components/schemas/ColorsDto'
      description: Colors an integrator customizes for the web its end clients see.
    JsonOkResponseLoginInfo:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          $ref: '#/components/schemas/LoginInfo'
    LoginInfo:
      type: object
      properties:
        token:
          type: string
        loginUrl:
          type: string
    JsonPaging:
      type: object
      properties:
        next:
          type: string
    ColorsDto:
      required:
      - blue
      - charcoal
      - cobalt
      - cyan
      - darkYellow
      - green
      - lightYellow
      - pink
      - purple
      - red
      - slate
      - teal
      - yellow
      type: object
      properties:
        blue:
          minLength: 1
          type: string
        teal:
          minLength: 1
          type: string
        pink:
          minLength: 1
          type: string
        yellow:
          minLength: 1
          type: string
        lightYellow:
          minLength: 1
          type: string
        darkYellow:
          minLength: 1
          type: string
        purple:
          minLength: 1
          type: string
        cyan:
          minLength: 1
          type: string
        red:
          minLength: 1
          type: string
        green:
          minLength: 1
          type: string
        slate:
          minLength: 1
          type: string
        charcoal:
          minLength: 1
          type: string
        cobalt:
          minLength: 1
          type: string
      description: Chart colors, always the 13 of them (Metricool defaults where not customized).
    WhitelabelCustomizationUpdateDto:
      type: object
      properties:
        themeColorPalette:
          $ref: '#/components/schemas/ThemeColorsDto'
        colors:
          $ref: '#/components/schemas/ColorsDto'
      description: Body of the customization PATCH. Only the fields listed in the 'fields' query param are applied.
    ThemeColorsDto:
      type: object
      properties:
        topMenuBackgroundColor:
          type: string
          description: Top menu background color
        topMenuTextColor:
          type: string
          description: Top menu text color
        topMenuSeparatorColor:
          type: string
          description: Top menu separator color
        primaryButtonBackgroundColor:
          type: string
          description: Primary button background color
        primaryButtonBorderColor:
          type: string
          description: Primary button border color
        primaryButtonTextColor:
          type: string
          description: Primary button text color
        secondaryButtonBackgroundColor:
          type: string
          description: Secondary button background color
        secondaryButtonBorderColor:
          type: string
          description: Secondary button border color
        secondaryButtonTextColor:
          type: string
          description: Secondary button text color
        backgroundColor:
          type: string
          description: General background color
      description: '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.'