Update a workspace

Changes the workspace name. Requires the admin role. Send the revision from a read: the update fails with a conflict when another writer changed the workspace first.

PATCH/v1/workspaces/{workspaceId}

Authentication

Send your Graphon API key with every request. The value is the whole API key that Graphon showed when you created it. See Authentication.

Authorization: Bearer <GRAPHON_API_KEY>

curl --request PATCH \
  --url "https://api.beta.graphon.ai/v1/workspaces/wspq7ws2np5l8z4" \
  --header "Authorization: Bearer $GRAPHON_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"Research","revision":1}'

Request

Loading your session…

Response

JSON

{
  "id": "wspq7ws2np5l8z4",
  "name": "Ada Lovelace’s workspace",
  "revision": 1
}

Path parameters

workspaceIdstring

The workspace id.

Request body

namestring

The new workspace name. 1 to 100 characters after trimming.

revisionnumber

The revision the caller read. The update fails when the workspace changed after that read.

Was this page helpful?

View as Markdown