Sign in

v1

latestOpenAPI 3.0.02026-08-063524105.9 KB
Workspaces

Update workspace

Updates workspace details. All fields are optional - only provided fields will be updated. Requires API key with access to the workspace.

patch/v1/workspaces/{id}

Path parameters

idstring uuid required

Workspace UUID

Example:123e4567-e89b-12d3-a456-426614174000

Request body

namestring

Workspace name

descriptionstring nullable

Workspace description (can be set to null)

timezonestring

Workspace timezone (IANA format)

contactPhonestring nullable

Contact phone (can be set to null)

Example request

{
  "name": "Updated Workspace Name",
  "description": "Updated description",
  "timezone": "Europe/London",
  "contactPhone": "+44123456789"
}

Response

Workspace updated successfully

idstring uuid required

Unique workspace identifier

accountIdstring uuid required

Account ID that owns this workspace

namestring required

Workspace name

descriptionstring nullable required

Optional workspace description

timezonestring required

Workspace timezone (IANA format)

contactEmailstring email nullable required

Contact email for workspace

contactPhonestring nullable required

Contact phone for workspace

createdAtstring date-time required

Workspace creation timestamp

updatedAtstring date-time required

Workspace last update timestamp

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "789e4567-e89b-12d3-a456-426614174000",
  "name": "My Workspace",
  "description": "Main workspace for customer campaigns",
  "timezone": "America/New_York",
  "contactEmail": "contact@example.com",
  "contactPhone": "+1234567890",
  "createdAt": "2025-12-11T12:00:00Z",
  "updatedAt": "2025-12-11T12:00:00Z"
}