For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
  • API Reference
      • GETList Workspaces
      • POSTCreate Workspace
      • GETGet Workspace
      • DELDelete Workspace
      • PATCHUpdate Workspace
  • Python SDK
    • Install
    • Usage
    • Errors
  • CLI
    • Overview
LogoLogo
API Referenceworkspaces

Update Workspace

PATCH
/api/v1/workspaces/:workspace_id
PATCH
/api/v1/workspaces/:workspace_id
$curl -X PATCH https://api.onepin.ai/api/v1/workspaces/workspace_id \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "data": {
3 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4 "name": "Marketing Team Workspace",
5 "slug": "marketing-team",
6 "color_idx": 4,
7 "created_by": "9b2d7f4e-8c3a-4f1a-9d2e-1a2b3c4d5e6f",
8 "created_at": "2024-01-15T09:30:00Z",
9 "updated_at": "2024-04-20T14:45:00Z"
10 },
11 "meta": {
12 "request_id": "7f8e9d6c-1234-4b56-8a9f-0b1c2d3e4f5a",
13 "timestamp": "2024-04-20T14:45:00Z"
14 }
15}

Update workspace name, color, and/or slug. Admin only.

Was this page helpful?
Previous

Create Upload

Next
Built with

Authentication

AuthorizationBearer
Clerk JWT token

Path parameters

workspace_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestring or nullOptional1-200 characters
slugstring or nullOptional
color_idxinteger or nullOptional

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error