Update a workspace group

patch/v1/workspace-groups/{workspace_group_id}

Renames a workspace group. Actor must be owner or admin.

Requires a bearer token: Authorization: Bearer <token>.

Path parameters

NameTypeRequiredDescription
workspace_group_idstring <uuid>YesGroup ID.e.g. 00000000-0000-4000-8000-000000000000

Request

cURL
curl -X PATCH https://api.wellapp.ai/v1/workspace-groups/{workspace_group_id} \
  -H "Authorization: Bearer $WELL_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "data": {
    "type": "workspace-group",
    "attributes": {
      "name": "Foldspace HoldCo"
    }
  }
}'
Request body
{
  "data": {
    "type": "workspace-group",
    "attributes": {
      "name": "Foldspace HoldCo"
    }
  }
}

Responses

200 — Updated group.

{
  "data": {
    "type": "workspace-group",
    "id": "wg_1",
    "attributes": {
      "name": "Foldspace HoldCo"
    },
    "relationships": {
      "created_by": {
        "data": {
          "type": "ManyToOne",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      }
    }
  }
}

400 — Validation error.

{
  "code": "BAD_REQUEST",
  "status": 400,
  "title": "Bad Request",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

401 — Unauthorized.

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

403 — Not owner/admin.

{
  "code": "FORBIDDEN",
  "status": 403,
  "title": "Forbidden",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

404 — Not found.

{
  "code": "NOT_FOUND",
  "status": 404,
  "title": "Not Found",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}