Files
dashback/docs/api/routes/supplier/update.md
2026-10-28 23:09:50 +01:00

58 lines
1.1 KiB
Markdown

# `PATCH /supplier/{id}`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Update supplier
Renames a supplier for the selected company.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `id` | yes | integer | |
## Body (JSON)
| Field | Required | Type | Description |
|-------|----------|------|-------------|
| `name` | yes | string | |
```json
{
"name": "Großhandel Müller GmbH"
}
```
## Signals
On success, emits SSE signal: `supplier` (see [`GET /events`](../events.md)).
## Response `200`
Updated supplier
```json
{
"supplier": {
"id": 1,
"name": "…",
"createdAt": "2026-08-10T00:00:00.000Z",
"updatedAt": "2026-08-10T00:00:00.000Z"
}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Name required, invalid id, or no company selected — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Supplier or company not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._