MImistral
beta.admin.workspaces

Create Workspace

Changed on

Create a Workspace.

post/v1/admin/workspaces

Request

Request body

namestring required

Workspace name.

descriptionstring

Workspace description.

iconstring

Workspace icon.

add_all_org_membersboolean

Whether to add all Organization members to the Workspace.

admin_user_idstring uuid required

User ID to grant the Workspace Admin role to.

Example request

{
  "name": "Product Team",
  "description": "Workspace for product and design teams",
  "icon": "★"
}

Response

OK

uuidstring uuid required

Workspace ID.

namestring required

Workspace name.

descriptionstring nullable required

Workspace description.

iconstring nullable required

Workspace icon.

members_countinteger nullable

Number of members in the Workspace.

groups_countinteger nullable

Number of groups assigned to the Workspace.

is_defaultboolean required

Whether this is the default Workspace for the Organization.

Example response

{
  "name": "Product Team",
  "description": "Workspace for product and design teams",
  "icon": "★",
  "groups_count": 3,
  "spend_limit": {
    "currency": "USD"
  }
}

Changes

  • 6c349f3bdef6Revision changes
    • warning

      added the new 7e69e493-caf6-4671-af60-84951754d9fc enum value to the / response property for the response status

    • warning

      added the new 7e69e493-caf6-4671-af60-84951754d9fc enum value to the // response property for the response status

    • warning

      added the new 94ef59cf-56bf-4383-9dd6-1fee77d370af enum value to the / response property for the response status

    • warning

      added the new 94ef59cf-56bf-4383-9dd6-1fee77d370af enum value to the // response property for the response status

  • fa73befe1c61Revision changes
    • warning

      added the new 348fc8da-f6da-4464-ad3e-af7bc137e221 enum value to the / response property for the response status

    • warning

      added the new 348fc8da-f6da-4464-ad3e-af7bc137e221 enum value to the // response property for the response status

    • info

      added the optional property to the response with the status