API Reference

Update Project

Update a project's name, slug, or description. Validates the new fields, writes the audit row, and emits a project.updated webhook.

PATCH/org/projects/{project_id}

Authentication

Accepts a JWT bearer token (Authorization: Bearer eyJ…) or an API key (X-API-Key: ms_live_…). API-key callers should send X-Project-ID unless the key is project-locked. Cross-tenant operators must send X-Tenant-ID.

Path parameters

Field	Type	Required	Description
`project_id`	`string`	required	Project id to update.

Request body

Field	Type	Required	Description
`name`	`string`	optional	New display name.
`slug`	`string`	optional	New URL slug.
`description`	`string`	optional	New description.

request.json

{
  "description": "Tier-1 customer support assistant."
}

Response

Returns 200 OK with the following body.

Field	Type	Required	Description
`id`	`string`	optional	Project id.
`name`	`string`	optional	Display name.
`slug`	`string`	optional	URL slug.
`description`	`string`	optional	Description.
`updated_at`	`string`	optional	RFC 3339 UTC.

200.json

{
  "id": "proj_support_bot",
  "name": "Customer Support Bot",
  "slug": "support-bot",
  "description": "Tier-1 customer support assistant.",
  "updated_at": "2026-05-04T12:31:00Z"
}

Errors

Status	Code	Description
400	`validation_error`	Body or query failed schema validation. The error includes the offending `field` name.
401	`unauthenticated`	Missing or invalid bearer token / API key.
403	`forbidden`	Authenticated principal lacks the required scope, role, or project access.
404	`not_found`	Target resource does not exist or is not visible to the calling tenant.
429	`rate_limited`	Per-IP or per-route limit exceeded. Respect the `Retry-After` header.
500	`internal_error`	Unhandled server error. Quote the `request_id` when contacting support.

Examples

cURL

curl -X PATCH https://api.memorysync.io/org/projects/EXAMPLE_ID \
  -H "Authorization: Bearer $MEMORYSYNC_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Tier-1 customer support assistant."
}'

javascript

import { MemorySync } from 'memorysync'

const client = new MemorySync({ apiKey: process.env.MEMORYSYNC_KEY })

const result = await client.request({
  method: 'PATCH',
  path: '/org/projects/EXAMPLE_ID',
  body: {
    "description": "Tier-1 customer support assistant."
  },
})
console.log(result)

python

from memorysync import Client

client = Client(api_key=os.environ["MEMORYSYNC_KEY"])

result = client.request(
    method="PATCH",
    path="/org/projects/EXAMPLE_ID",
    json={
      "description": "Tier-1 customer support assistant."
    },
)
print(result)

Behavior & notes

Use DELETE /org/projects/{project_id} to soft-delete the project. Memory rows under the project are tombstoned. Renaming a project does not change its id; the slug is independent of routing.

← Previous

List Projects

Archive / Unarchive