Workspaces

Patch Workspace

Partially update a workspace using PATCH (merge-patch semantics). Only provided fields will be updated; omitted fields remain unchanged.

patch/v2/workspaces/{id}

Request

Base URL: https://{customer-domain}/maestro/api
URL: https://{customer-domain}/maestro/api/v2/workspaces/{id}
Auth: none declared

Path parameters

idstring required

ID of the workspace to be patched

Request body

idstring

Unique identifier of the entity

createdAtstring

Date/time when this entity was created

updatedAtstring

Date/time when this entity was last updated

aliasstring

Unique alias identifier for the workspace

namestring

Display name of the workspace. Maximum 256 characters; cannot be blank.

descriptionstring

Description of the workspace purpose and content. Maximum 1024 characters.

colorstring

Color theme for the workspace

iconstring

Icon identifier for the workspace

ownerIdstring

User ID of the workspace owner

Example request

{
  "id": "Ws69a976d02587b929c9e26dfa",
  "createdBy": {
    "id": "1C341E7B682505430A494138@0bd0200063c87f9749412b.e",
    "name": "Jane Doe"
  },
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedBy": {
    "id": "1C341E7B682505430A494138@0bd0200063c87f9749412b.e",
    "name": "Jane Doe"
  },
  "updatedAt": "2026-01-15T14:45:00.000Z",
  "alias": "marketing-workspace",
  "name": "Marketing Workspace",
  "description": "Workspace for managing marketing campaigns and assets",
  "color": "blue",
  "icon": "briefcase",
  "ownerId": "1C341E7B682505430A494138@0bd0200063c87f9749412b.e",
  "recordTypeSections": [
    {
      "displayName": "Marketing"
    }
  ]
}

Response