> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar a marca do tenant

> Faz upsert da marca do tenant. Todos os campos são opcionais: envie null para limpar, omita para manter. Cores em hex #RRGGBB; URLs https. Requer API key tenant-scoped (403 NUMBER_SCOPE_NOT_ALLOWED para keys por número). Upload de logo: POST /api/branding/logo (sessão do dashboard, multipart PNG/JPG/WebP ≤2MB).

**Requer uma chave com escopo de tenant.**



## OpenAPI

````yaml openapi.pt.json PUT /v1/branding
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/branding:
    put:
      tags:
        - Branding
      summary: Atualizar a marca do tenant
      description: >-
        Faz upsert da marca do tenant. Todos os campos são opcionais: envie null
        para limpar, omita para manter. Cores em hex #RRGGBB; URLs https. Requer
        API key tenant-scoped (403 NUMBER_SCOPE_NOT_ALLOWED para keys por
        número). Upload de logo: POST /api/branding/logo (sessão do dashboard,
        multipart PNG/JPG/WebP ≤2MB).


        **Requer uma chave com escopo de tenant.**
      operationId: put_branding
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                companyName:
                  type: string
                  description: Título do cabeçalho (substitui "Pilot Status").
                  example: Acme
                primaryColor:
                  type: string
                  description: Cor primária (botões/destaques).
                  example: '#1fd286'
                hidePilotStatusBranding:
                  type: boolean
                  description: 'White-label: esconde o rodapé "Pilot Status".'
                  example: 'true'
            example:
              companyName: Acme
              primaryColor: '#1fd286'
              hidePilotStatusBranding: true
      responses:
        '200':
          description: Definir marca
          content:
            application/json:
              example:
                branding:
                  companyName: Acme
                  primaryColor: '#1fd286'
                  hidePilotStatusBranding: true
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de número usada em endpoint exclusivo de tenant
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Number-scoped keys cannot call tenant endpoints
                code: NUMBER_SCOPE_NOT_ALLOWED
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````