Workspaces

Update workspace

Update workspace details

patch/workspaces/{workspace_id}

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4

Request body

Example request

{
  "patches": [
    {
      "op": "replace",
      "path": "name",
      "value": "My cool workspace"
    }
  ]
}

Response

Updated workspace details

namestring nullable

Name of the workspace

metadataobject nullable

Metadata for the workspace

plan_idinteger nullable

ID of the plan assigned to the workspace

billing_cyclestring nullable

Billing cycle for the workspace (monthly/yearly)

storage_gbinteger nullable

Chosen TOTAL storage allocation in GB on the plan

checkout_urlstring nullable

Present when the plan change requires payment. The FE should redirect the user here to complete checkout.

next_actionstring nullable

BE-decided next step for the FE after the plan change (none / checkout_required / contact_sales / ...).

next_action_messagestring nullable

Human-readable one-liner for the next action.

next_action_urlstring nullable

URL the FE should redirect to for the next action (mirrors checkout_url when the action is checkout).

Example response

{
  "metadata": {
    "value": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.