v9

latestOpenAPI 3.0.3raw.githubusercontent.com2026-07-2181734.3 KB
workspaces

Create a workspace

Creates a new partner-managed workspace and automatically provisions an Owner user. The workspace_id identifier is derived from the requested display_name (lowercase, alphanumeric and dashes, up to 30 characters). The workspace is created on the calling partner's plan and linked to that partner for ownership and billing-eligibility checks. An Owner user is created with a non-login, system-managed email of the form <user_id>-<workspace-id>@partners.timelines.ai and added to the default workspace group. Seats are allocated according to seats_purchased (1-999); the Owner consumes one seat and the remaining seats become available for additional agents. On success the response returns workspace metadata, seat counters and the newly created owner_user_id. Conflicts on identifier generation (duplicate workspace_id) are reported with a 409 WorkspaceCreationFailed error.

post/workspaces

Headers

X-TL-Partner-Idstring required

The unique identifier for the partner.

Request body

display_namestring required

Workspace display name

seats_purchasedinteger required

Number of workspace seats

Example request

{
  "display_name": "my-first-workspace (must contain only letters, digits and dash)",
  "seats_purchased": 3
}

Response

Workspace created

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"
      ]
    }
  ]
}
All 8 operations