Files
dashback/docs/api/routes/entity/address/update.md
seb 74269cd3ef Add customergroup and entity HTTP APIs with address and contact routes.
Expose store-backed CRUD for customer groups, entities, nested addresses, and contacts, matching the documented dashdbschema contracts.
2026-08-06 07:38:05 +02:00

58 lines
1.1 KiB
Markdown

# `PATCH /entity/{entityId}/address/{id}`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Update entity address
Patches address fields that are present.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `entityId` | yes | integer | |
| `id` | yes | integer | |
## Body (JSON)
```json
{
"city": "München",
"zip": "80331"
}
```
## Response `200`
Updated address
```json
{
"address": {
"id": 1,
"entityId": 1,
"firstName": "…",
"name": "…",
"street": "…",
"streetNumber": "…",
"zip": "…",
"city": "…",
"county": "…",
"addressType": "…"
}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Address type required, invalid ids, or no company selected — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Address, entity, or company not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._