Skip to main content
PATCH
/
spaces
/
{id}
TypeScript SDK
import { Orchata } from '@orchata/sdk';

const client = new Orchata({ apiKey: 'oai_your_api_key' });

const { space } = await client.spaces.update('space_123', {
  name: 'Updated Name',
  description: 'New description'
});
{
  "space": {
    "id": "<string>",
    "orgId": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "icon": "folder",
    "description": "<string>",
    "isArchived": true,
    "archivedAt": "2023-12-25",
    "createdAt": "2023-12-25",
    "updatedAt": "2023-12-25"
  }
}

Authorizations

Oai-Api-Key
string
header
required

Path Parameters

id
string
required
Example:

"space_123"

Body

application/json

Space update data

name
string
Required string length: 1 - 100
icon
enum<string>
Available options:
folder,
book,
file-text,
database,
package,
archive,
briefcase,
inbox,
layers,
box
description
string
Required string length: 1 - 500
slug
string
Required string length: 1 - 100
isArchived
boolean

Response

Space updated successfully

space
object
required