API Reference

Platform

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update

client.platform.update(PlatformUpdateParams { displayName } body, RequestOptionsoptions?): PlatformUpdateResponse { data }

POST/platform

Updates platform details (creates if not exists)

ParametersExpand Collapse

body: PlatformUpdateParams { displayName }

displayName: string

Display name for the platform

ReturnsExpand Collapse

PlatformUpdateResponse { data }

data: Data { created, displayName, workspaceId, modified }

Platform object

created: string

ISO 8601 timestamp when the platform was created

formatdate-time

displayName: string

Display name for the platform

workspaceId: string

Workspace ID this platform belongs to

modified?: string

ISO 8601 timestamp when the platform was last modified

formatdate-time

Update

TypeScript

HTTP

TypeScript

Python

import Fragment from '@fragment-dev/ts-node';

const client = new Fragment();

const platform = await client.platform.update({ displayName: 'Acme Corp' });

console.log(platform.data);

200 example

{
  "data": {
    "created": "2024-01-13T00:00:00Z",
    "displayName": "Acme Corp",
    "workspaceId": "ws_1234567890",
    "modified": "2024-01-14T00:00:00Z"
  }
}

Returns Examples

200 example

{
  "data": {
    "created": "2024-01-13T00:00:00Z",
    "displayName": "Acme Corp",
    "workspaceId": "ws_1234567890",
    "modified": "2024-01-14T00:00:00Z"
  }
}