Update records
POST /api/v1/entities/update: request fields and declared response contract.
POST/api/v1/entities/update
| Permission | parties.updateRecord |
|---|---|
| Workspace scope | required |
| Scope target | entity-kind |
Request body
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| entityKind | string | required | non-null | — |
| entityId | string | required | non-null | — |
| patch | object | required | non-null | — |
| interfaceName | "Pipelineable" | "Contactable" | "Listable" | "Scoreable" | "Agreement" | optional | non-null | — |
| reason | string | optional | non-null | — |
| expectedObjectVersion | string | optional | non-null | — |
| expectedPolicyVersion | string | optional | non-null | — |
| idempotencyKey | string | optional | non-null | — |
| dryRun | boolean | optional | non-null | true |
Response
201
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| data | unknown | required | non-null | — |
Declared failures
| ACCESS_DENIED | 403 — not retryable |
|---|---|
| CORE_ERROR | 500 — not retryable |
| GOVERNANCE_DENIED | 403 — not retryable |
| ONTOLOGY_VALUE_INVALID | 422 — not retryable |
| QUOTA_DENIED | 429 — retryable |
| VALIDATION_ERROR | 400 — not retryable |
| VALIDATION_INPUT_ERROR | 400 — not retryable |
Readback
Read the result back with:
- entities.get
Request example
Schematic only. Replace placeholders with real values and include all required nested fields.
POST /api/v1/entities/update HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json
{
"entityKind": "<entityKind>",
"entityId": "<entityId>",
"patch": {}
}