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

# Update workspace

> Updates a workspace's display name, timezone, time format, brand color, or logo.

Pass only the fields you want to change — anything you leave out stays the same. To remove the logo, send `logoUrl: null`.

The URL slug can't be changed after creation (it's part of every workspace link). If you need a different slug, create a new workspace.

Only workspace **owners** and **admins** can edit a workspace.



## OpenAPI

````yaml /openapi.json patch /workspaces/{workspaceId}
openapi: 3.0.0
info:
  title: Postbreeze API
  description: >-
    Public REST API for scheduling and managing social posts. Authenticate every
    request with `Authorization: Bearer pb_live_…`. All endpoints are scoped to
    a single workspace; an API key issued for workspace A cannot access
    workspace B.
  version: 1.0.0
  contact: {}
servers:
  - url: http://localhost:4100/api/v1
security:
  - bearer: []
tags: []
paths:
  /workspaces/{workspaceId}:
    patch:
      tags:
        - Workspaces
      summary: Update workspace
      description: >-
        Updates a workspace's display name, timezone, time format, brand color,
        or logo.


        Pass only the fields you want to change — anything you leave out stays
        the same. To remove the logo, send `logoUrl: null`.


        The URL slug can't be changed after creation (it's part of every
        workspace link). If you need a different slug, create a new workspace.


        Only workspace **owners** and **admins** can edit a workspace.
      operationId: WorkspacesController_update
      parameters:
        - name: workspaceId
          required: true
          in: path
          description: Prefixed cuid of the workspace to update.
          schema:
            example: ws_01HZX5T2K9Q3RB6N6JZP3RYV0M
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkspaceDto'
      responses:
        '200':
          description: The updated workspace.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Prefixed cuid identifier.
                  name:
                    type: string
                    description: Display name.
                  slug:
                    type: string
                    description: Globally unique URL slug.
                  ownerUserId:
                    type: string
                    description: User id of the workspace owner.
                  timezone:
                    type: string
                    description: IANA timezone the workspace is scheduled against.
                  timeFormat:
                    type: string
                    enum:
                      - H24
                      - H12
                    description: Hour format used in the UI.
                  brandColor:
                    type: string
                    nullable: true
                    description: >-
                      Brand hex color used in the dashboard chrome. `null` when
                      unset.
                  logoUrl:
                    type: string
                    nullable: true
                    description: Workspace logo URL. `null` when unset.
                  deletedAt:
                    type: string
                    format: date-time
                    nullable: true
                    description: >-
                      Set when the workspace has been soft-deleted; otherwise
                      `null`.
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  code:
                    type: string
                    example: VALIDATION_FAILED
                  message:
                    type: string
                  requestId:
                    type: string
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  message:
                    type: string
                    example: Unauthorized
                  requestId:
                    type: string
components:
  schemas:
    UpdateWorkspaceDto:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 80
        timezone:
          type: string
          description: IANA timezone.
        timeFormat:
          type: string
          enum:
            - H24
            - H12
        brandColor:
          type: string
          description: Brand hex color used in the dashboard chrome.
        logoUrl:
          type: string
          nullable: true
          description: Workspace logo URL, or `null` to clear.
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: Your Postbreeze API key

````