ARarbicity
workspace

Update Workspace

Changed on

Update workspace metadata such as name, description, or public status. Changes are persisted to the database.

Only developers can change the is_public field. When making a workspace public, the backend uses the Workspace-Key header to get the workspace key.

patch/api/workspace/{workspace_ext_id}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

workspace_ext_idstring required

Headers

workspace-keystring

Request body

namestring nullable
descriptionstring nullable
is_publicboolean nullable

Response

Successful Response

external_idstring required
namestring required
descriptionstring nullable required
is_publicboolean required
created_by_ext_idstring required
updated_by_ext_idstring nullable
created_atstring date-time required
updated_atstring date-time required
wrapped_keystring nullable
shared_conversation_countinteger
private_conversation_countinteger
shared_document_countinteger
private_document_countinteger
user_files_mbnumber

Changes

  • b91e4b449d56Revision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • aa4b06f8dedeRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status