Update Workspace Config

Update a workspace’s config field. Top-level keys (schema, block, value) are merged shallowly with the current config; only the keys present in the payload are replaced.

PATCH /v2/workspaces/{workspaceId}/config

Update Workspace Config

cURL

curl --request PATCH \
  --url https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema": {},
  "block": "<string>",
  "value": "<unknown>"
}
'

200

{
  "schema": {},
  "block": "<string>",
  "value": "<unknown>"
}

Authorizations

BearerAuthOrgApiKeyAuthBearerAuth & OrgApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId · string · required

Workspace id

Body

application/json

schema · object

Hide child attributes

schema. {key} · object

Hide child attributes

schema.{key}. type · enum<string>

Available options: string, number, object, array, boolean, localized:string, localized:number, localized:boolean

schema.{key}. format · string

schema.{key}. properties · object

Hide child attributes

schema.{key}.properties. {key} · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

schema.{key}. title · object string

Hide child attributes

schema.{key}.title. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

schema.{key}. description · object string

Hide child attributes

schema.{key}.description. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

schema.{key}. items · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

schema.{key}. ui:widget · string

schema.{key}. ui:options · object

Example:

{
  "type": "string",
  "title": { "en": "User ID" },
  "description": { "en": "The unique identifier of the user" },
  "secret": { "type": "boolean" },
  "event": { "type": "boolean" }
}

block · string

value · any

Response

200

application/json

Success Response

schema · object

Hide child attributes

schema. {key} · object

Hide child attributes

schema.{key}. type · enum<string>

Available options: string, number, object, array, boolean, localized:string, localized:number, localized:boolean

schema.{key}. format · string

schema.{key}. properties · object

Hide child attributes

schema.{key}.properties. {key} · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

schema.{key}. title · object string

Hide child attributes

schema.{key}.title. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

schema.{key}. description · object string

Hide child attributes

schema.{key}.description. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

schema.{key}. items · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

schema.{key}. ui:widget · string

schema.{key}. ui:options · object

Example:

{
  "type": "string",
  "title": { "en": "User ID" },
  "description": { "en": "The unique identifier of the user" },
  "secret": { "type": "boolean" },
  "event": { "type": "boolean" }
}

block · string

value · any