---
title: "UpdateSwarmBody"
description: "Request body for updating a Swarm."
section: "Reference"
group: "Types"
order: 216
---

## Definition

```ts
interface UpdateSwarmBody {
  name?: string | undefined;
  description?: string | undefined;
  runtimeUserId?: string | null | undefined;
}
```

## Fields

| Field           | Type                          | Notes                                                                                                                                                                  |
| --------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`          | `string \| undefined`         | `optional` — New name                                                                                                                                                  |
| `description`   | `string \| undefined`         | `optional` — New description                                                                                                                                           |
| `runtimeUserId` | `string \| null \| undefined` | `optional` — Override the workspace default service user as the runtime caller when this swarm runs headlessly. Null clears the override. Workspace-admin-only to set. |