65 lines
1.4 KiB
Markdown
65 lines
1.4 KiB
Markdown
# `PATCH /entity/{id}`
|
|
|
|
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
|
|
|
Update entity
|
|
|
|
Patches fields that are present (`name`, `firstName`, `number`).
|
|
`number` is only changed when the key is present (no auto-allocate).
|
|
Writes `entityhistory` when values change.
|
|
|
|
|
|
## Path parameters
|
|
|
|
| Param | Required | Type | Description |
|
|
|-------|----------|------|-------------|
|
|
| `id` | yes | integer | |
|
|
|
|
## Body (JSON)
|
|
|
|
| Field | Required | Type | Description |
|
|
|-------|----------|------|-------------|
|
|
| `name` | no | string | |
|
|
| `firstName` | no | string | |
|
|
| `number` | no | string | |
|
|
|
|
```json
|
|
{
|
|
"name": "Müller",
|
|
"firstName": "Anna",
|
|
"number": "10042"
|
|
}
|
|
```
|
|
|
|
## Response `200`
|
|
|
|
Updated entity
|
|
|
|
```json
|
|
{
|
|
"entity": {
|
|
"id": 1,
|
|
"customergroupId": 1,
|
|
"firstName": "…",
|
|
"name": "…",
|
|
"number": "…",
|
|
"createdAt": "2026-08-10T00:00:00.000Z",
|
|
"updatedAt": "2026-08-10T00:00:00.000Z"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Errors
|
|
|
|
| Status | Description |
|
|
|--------|-------------|
|
|
| 400 | Name/number required, invalid id, or no company selected — `{"error":"…"}` |
|
|
| 401 | Unauthorized — `{"error":"…"}` |
|
|
| 403 | Not authorized — `{"error":"…"}` |
|
|
| 404 | Entity or company not found — `{"error":"…"}` |
|
|
| 409 | Number already in use — `{"error":"…"}` |
|
|
|
|
---
|
|
|
|
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|