# Replace doctypes

URL: https://docs.hanzo.ai/docs/openapi/framework/put-framework-doctypes-by-name

> Replaces a DocType definition wholesale (PUT semantics): the stored definition becomes the body.

`PUT /v1/framework/doctypes/{name}`

> [Framework →](https://docs.hanzo.ai/docs/openapi/framework) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                     |
| ------------- | --------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/framework/doctypes/{name}` |
| **Method**    | `PUT`                                               |
| **Operation** | `put_framework_doctypes_by_name`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`              |

Replaces a DocType definition wholesale (PUT semantics): the
stored definition becomes the body. The name in the URL is authoritative over
the body's, and documents already stored under the DocType are left intact.
Manager-only.

## Request

30 fields, body `application/json` (required).

| Field                  | In   | Type                  | Required | Description |
| ---------------------- | ---- | --------------------- | -------- | ----------- |
| `name`                 | path | string                | yes      |             |
| `autoname`             | body | string                | —        |             |
| `createdAt`            | body | integer (int64)       | —        |             |
| `fields`               | body | framework.DocField\[] | —        |             |
| `fields[].default`     | body | string                | —        |             |
| `fields[].fetchFrom`   | body | string                | —        |             |
| `fields[].fieldname`   | body | string                | —        |             |
| `fields[].fieldtype`   | body | string                | —        |             |
| `fields[].hidden`      | body | boolean               | —        |             |
| `fields[].inListView`  | body | boolean               | —        |             |
| `fields[].label`       | body | string                | —        |             |
| `fields[].options`     | body | string                | —        |             |
| `fields[].readOnly`    | body | boolean               | —        |             |
| `fields[].reqd`        | body | boolean               | —        |             |
| `fields[].unique`      | body | boolean               | —        |             |
| `immutable`            | body | boolean               | —        |             |
| `isSingle`             | body | boolean               | —        |             |
| `isSubmittable`        | body | boolean               | —        |             |
| `module`               | body | string                | —        |             |
| `name`                 | body | string                | —        |             |
| `permissions`          | body | framework.DocPerm\[]  | —        |             |
| `permissions[].cancel` | body | boolean               | —        |             |
| `permissions[].create` | body | boolean               | —        |             |
| `permissions[].delete` | body | boolean               | —        |             |
| `permissions[].read`   | body | boolean               | —        |             |
| `permissions[].role`   | body | string                | —        |             |
| `permissions[].submit` | body | boolean               | —        |             |
| `permissions[].write`  | body | boolean               | —        |             |
| `titleField`           | body | string                | —        |             |
| `updatedAt`            | body | integer (int64)       | —        |             |

## Response

| Status    | Body              | Meaning |
| --------- | ----------------- | ------- |
| `200`     | framework.DocType | ok      |
| `default` | problem-details   | refused |

`200` body — 29 fields.

| Field                  | In   | Type                  | Always | Description |
| ---------------------- | ---- | --------------------- | ------ | ----------- |
| `autoname`             | body | string                | —      |             |
| `createdAt`            | body | integer (int64)       | —      |             |
| `fields`               | body | framework.DocField\[] | —      |             |
| `fields[].default`     | body | string                | —      |             |
| `fields[].fetchFrom`   | body | string                | —      |             |
| `fields[].fieldname`   | body | string                | —      |             |
| `fields[].fieldtype`   | body | string                | —      |             |
| `fields[].hidden`      | body | boolean               | —      |             |
| `fields[].inListView`  | body | boolean               | —      |             |
| `fields[].label`       | body | string                | —      |             |
| `fields[].options`     | body | string                | —      |             |
| `fields[].readOnly`    | body | boolean               | —      |             |
| `fields[].reqd`        | body | boolean               | —      |             |
| `fields[].unique`      | body | boolean               | —      |             |
| `immutable`            | body | boolean               | —      |             |
| `isSingle`             | body | boolean               | —      |             |
| `isSubmittable`        | body | boolean               | —      |             |
| `module`               | body | string                | —      |             |
| `name`                 | body | string                | —      |             |
| `permissions`          | body | framework.DocPerm\[]  | —      |             |
| `permissions[].cancel` | body | boolean               | —      |             |
| `permissions[].create` | body | boolean               | —      |             |
| `permissions[].delete` | body | boolean               | —      |             |
| `permissions[].read`   | body | boolean               | —      |             |
| `permissions[].role`   | body | string                | —      |             |
| `permissions[].submit` | body | boolean               | —      |             |
| `permissions[].write`  | body | boolean               | —      |             |
| `titleField`           | body | string                | —      |             |
| `updatedAt`            | body | integer (int64)       | —      |             |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo framework doctypes set <name>
```

**SDK**

**.ts**

```ts
import { Configuration, FrameworkApi } from 'hanzoai';

const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putFrameworkDoctypesByName({ name: 'name', autoname: "<autoname>", createdAt: 0 });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FrameworkApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FrameworkApi(client).put_framework_doctypes_by_name(name='name', autoname="<autoname>", created_at=0)
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FrameworkAPI.PutFrameworkDoctypesByName(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, framework_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = framework_api::put_framework_doctypes_by_name(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FrameworkApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new FrameworkApi(client).putFrameworkDoctypesByName();
```

**HTTP**

```bash
curl -X PUT https://api.hanzo.ai/v1/framework/doctypes/<name> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "autoname": "<autoname>",
       "createdAt": 0
     }'
```

**MCP**

MCP reaches **framework** through the `framework` tool, which names its 14 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_framework_by_doctype"
         }
       }
     }'
```

---

[Framework API](https://docs.hanzo.ai/docs/openapi/framework) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)