Update the name, description, or metadata of a Forward Memory Store.
Updates a Memory Store's
The request body must contain at least one of these fields.
HTTP 200 OK
Returns a Memory Store object.
name, description, or metadata. This endpoint uses partial-update semantics: omitted fields remain unchanged, and null values are rejected.
Path
POST /api/v1/forward/memory_stores/{memory_store_id}
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or admin SAT> |
Content-Type | Yes | application/json |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
memory_store_id | string | Yes | Memory Store ID (memstore_...). |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | New name. When supplied, it must be non-empty and cannot contain non-printable control characters. |
description | string | No | New description. When supplied, it cannot contain non-printable control characters. |
metadata | object | No | New metadata. It replaces the current metadata instead of being merged. See Store metadata constraints. |
Example request
Example response
HTTP 200 OK
Response
Returns a Memory Store object.
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | The request body is invalid: no field is supplied, name is empty or contains control characters, or metadata violates its constraints. |
| 401 | authentication_error | The authentication token is missing or invalid. |
| 403 | permission_error | The caller cannot access the resource. |
| 404 | not_found_error | The Store does not exist or is not visible across users. |
| 409 | conflict_error | The Store is archived and cannot be modified. |
| 500/502/503 | api_error | Forward or a dependent service failed. |