# Update view **Endpoint:** `PATCH /v2/prism/{teamId}/{objectType}/views/{viewId}` **Operation ID:** `patchView` **Server:** `https://developers.micro.so` **Security:** `[{"apiKey":[]}]` ## Parameters ```json [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ViewObjectType" } }, { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ] ``` ## Request body ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewBundlePatch" } } } } ``` ## Responses ```json { "200": { "description": "OK", "headers": { "x-request-id": { "$ref": "#/components/headers/XRequestId" }, "etag": { "$ref": "#/components/headers/ETag" }, "idempotent-replay": { "$ref": "#/components/headers/IdempotentReplay" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewBundle" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } ``` ## Referenced components ```json { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "Public API key generated from Micro settings. Sent as the `x-api-key` header and validated by AWS API Gateway in front of the service." } }, "schemas": { "ViewObjectType": { "type": "string", "enum": [ "comment", "action", "deal", "engagement", "document", "event", "identity", "organization" ] }, "ViewBundlePatch": { "type": "object", "description": "Partial update. Any of select/filter/sort, when present, replaces that group wholesale.", "properties": { "name": { "type": "string" }, "icon": { "type": [ "string", "null" ] }, "view_type": { "type": "string" }, "combinator": { "type": "string", "enum": [ "AND", "OR" ] }, "sort_order": { "type": [ "integer", "null" ] }, "column_layout": { "type": [ "object", "null" ], "additionalProperties": true }, "team_id": { "type": [ "string", "null" ], "format": "uuid" }, "list_id": { "type": [ "string", "null" ], "format": "uuid" }, "user_id": { "type": [ "string", "null" ] }, "group_by": { "type": [ "string", "null" ] }, "group_sort": { "type": [ "string", "null" ] }, "group_hide_empty": { "type": [ "boolean", "null" ] }, "group_hidden_option_ids": { "type": [ "array", "object", "null" ] }, "aggregation_type": { "type": [ "string", "null" ] }, "aggregation_prop_def_id": { "type": [ "string", "null" ], "format": "uuid" }, "select": { "type": "array", "items": { "type": "string" } }, "filter": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sort": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "additionalProperties": false }, "ViewBundle": { "type": "object", "description": "A view (saved configuration for displaying records of a given object type) plus its select/filter/sort children. Properties in select/filter/sort are referenced by slug.", "properties": { "id": { "type": "string", "format": "uuid" }, "team_id": { "type": [ "string", "null" ], "format": "uuid" }, "list_id": { "type": [ "string", "null" ], "format": "uuid" }, "user_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "icon": { "type": [ "string", "null" ] }, "view_type": { "type": "string" }, "combinator": { "type": "string", "enum": [ "AND", "OR" ] }, "sort_order": { "type": [ "integer", "null" ] }, "column_layout": { "type": [ "object", "null" ], "additionalProperties": true }, "group_by": { "type": [ "string", "null" ], "description": "Property slug to group by" }, "group_sort": { "type": [ "string", "null" ] }, "group_hide_empty": { "type": [ "boolean", "null" ] }, "group_hidden_option_ids": { "type": [ "array", "object", "null" ] }, "aggregation_type": { "type": [ "string", "null" ] }, "aggregation_prop_def_id": { "type": [ "string", "null" ], "format": "uuid" }, "select": { "type": "array", "description": "Property slugs (dot-paths permitted for refs)", "items": { "type": "string" } }, "filter": { "type": "array", "description": "Each entry is { slug: { comparator: value } }", "items": { "type": "object", "additionalProperties": true } }, "sort": { "type": "array", "description": "Each entry is { slug: 'asc' | 'desc' }", "items": { "type": "object", "additionalProperties": true } }, "created_at": { "type": "string" }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "name", "view_type" ], "additionalProperties": false }, "Error": { "type": "object", "description": "Canonical JSON error envelope for every non-2xx v2 API response. `error.code` is the machine-readable error code, `error.message` is the human-readable summary, and `error.request_id` identifies the request for support. When supplied, `error.errors` contains field-level validation issues.", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string", "description": "Stable machine-readable code. Branch on this, not on the HTTP status, to handle specific failure modes.", "example": "invalid_request" }, "message": { "type": "string", "description": "Human-readable summary suitable for logs. Not localized; do not display verbatim to end users." }, "request_id": { "type": [ "string", "null" ], "description": "Echo of the x-request-id response header. Include in support requests." }, "errors": { "type": "array", "description": "Optional structured field-level validation issues when the server provides them.", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "JSON path of the offending property (e.g. \".body.default.email\")." }, "message": { "type": "string" }, "code": { "type": "string", "description": "Validator-specific code (e.g. \"required.openapi.validation\")." } }, "required": [ "message" ] } }, "details": { "type": "object", "description": "Optional bag of error-specific context. Shape varies by code; clients should treat fields as opaque unless documented." } } } } } }, "parameters": { "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": false, "description": "A unique key (UUID or any opaque string up to 255 chars) for an authenticated POST, PUT, or PATCH request. The server retains the initial claim for 24 hours and replays a completed non-5xx response only when the method, path, and request body all match. Reusing a non-expired key with a different method, path, or body returns 409 `idempotency_key_mismatch`; reusing it after expiry returns 409 `idempotency_key_stale`, so use a new key. Replays include the `idempotent-replay: true` response header.", "schema": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "headers": { "XRequestId": { "description": "Correlation ID. Echoed from the request `x-request-id` header when supplied, otherwise generated. Include in support requests.", "schema": { "type": "string" } }, "ETag": { "description": "Weak entity tag for the returned record. Capture and send back as `If-Match` on a subsequent PATCH or DELETE to enforce optimistic concurrency.", "schema": { "type": "string" } }, "IdempotentReplay": { "description": "Present and set to `true` when this response is a cached replay of an earlier request with the same `Idempotency-Key`. Absent on first execution.", "schema": { "type": "string", "enum": [ "true" ] } } }, "responses": { "BadRequest": { "description": "Request validation failed. Inspect `error.errors` for field-level details.", "headers": { "x-request-id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "Missing or invalid credentials. API Gateway maps a missing or invalid `x-api-key` to HTTP 401 with this envelope (including `request_id`). A 403 here means the key was accepted but the caller is not permitted.", "headers": { "x-request-id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Forbidden": { "description": "Authenticated but not permitted to perform this action.", "headers": { "x-request-id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "Resource or route does not exist.", "headers": { "x-request-id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "InternalError": { "description": "Unexpected server error. Retry with backoff; report `request_id` if persistent.", "headers": { "x-request-id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } ```