INinitechsoftware
workspaces

Update workspace

Changed on

Updates mutable workspace attributes for a partner-managed workspace. Partners can change the human-readable display_name and/or adjust the number of purchased seats (seats_purchased, 1-999). When the purchased seats are reduced below current utilization, the platform may automatically suspend users and their associated WhatsApp accounts to comply with the new limit. The response returns the updated workspace representation, including seat counters and, when applicable, details of suspended members so partners can reconcile the downgrade on their side. Standard partner ownership and billing eligibility checks apply before processing the update.

patch/workspaces/{workspace_id}

Request

  • Base URL
    https://app.timelines.ai/partner/api/v1
  • Auth
    HTTP bearer

Path parameters

workspace_idstring required

The unique identifier for the workspace.

Headers

X-TL-Partner-Idstring required

The unique identifier for the partner.

Request body

display_namestring

New workspace display name

seats_purchasedinteger

New number of workspace seats

Example request

{
  "display_name": "updated-workspace-name",
  "seats_purchased": 5
}

Response

Workspace updated

workspace_idstring required

Unique identifier for the workspace

display_namestring required

Workspace display name

plan_idinteger required

Workspace plan type

seats_totalinteger required

Total number of seats in the workspace

seats_availableinteger required

Number of available seats in the workspace

updated_atstring date-time

Timestamp of the last update

owner_user_idinteger

User ID of the workspace owner

group_idinteger

Group ID associated with the workspace

created_atstring date-time

Timestamp of workspace creation

Example response

{
  "workspace_id": "ws_1234567890abcdef",
  "display_name": "my-first-workspace",
  "plan_id": 1,
  "seats_total": 3,
  "seats_available": 2,
  "updated_at": "2024-01-01T12:00:00Z",
  "owner_user_id": 42,
  "group_id": 7,
  "created_at": "2024-01-01T10:00:00Z",
  "suspended_members": [
    {
      "user_id": 123,
      "whatsapp_account_id": 1092930,
      "phone_numbers": [
        "+1234567890"
      ]
    }
  ]
}

Changes