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

# Update a workspace



## OpenAPI

````yaml /openapi.json patch /workspaces/{workspaceId}
openapi: 3.1.0
info:
  title: subscriber.dev API
  description: >-
    Trigger workflows, manage subscribers and send broadcasts. Authenticate with
    an API key in the X-API-Key header: the key decides the environment. Docs:
    https://docs.subscriber.dev
  version: '1.0'
  contact: {}
servers:
  - url: https://api.subscriber.dev
    description: Cloud
security: []
tags: []
paths:
  /workspaces/{workspaceId}:
    patch:
      tags:
        - Workspaces
      summary: Update a workspace
      operationId: updateWorkspace
      parameters:
        - name: workspaceId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkspaceRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limited. Wait a second and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearer: []
components:
  schemas:
    UpdateWorkspaceRequest:
      type: object
      properties:
        postalAddress:
          description: >-
            The business's physical postal address, shown in every email's
            footer. Shown on one line; line breaks become commas. Send null or
            an empty string to remove it.
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
      required:
        - postalAddress
    Workspace:
      type: object
      properties:
        id:
          type: number
        publicId:
          type: string
        name:
          type: string
        slug:
          type: string
        postalAddress:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - id
        - publicId
        - name
        - slug
        - postalAddress
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        message:
          type: string
          example: Workflow not found
        error:
          type: string
          example: Not Found
        errors:
          description: Which fields failed validation, on a 400.
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
              code:
                type: string
            required:
              - path
              - message
      required:
        - statusCode
        - message
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
      description: >-
        A session token from `subscriber login`, used by subscriber.dev's own
        apps. Requests about an environment also need its ID in the
        `x-environment-id` header. From your own code, use an API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.