Update a resource

PATCH

/api/v1/resources/{id}

curl --request PATCH \
  --url 'https://example.com/api/v1/resources/example?projectId=00000000-0000-0000-0000-000000000000' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example" }'

• Current server

Parameters

Path Parameters

id

required

string

Query Parameters

projectId

required

Project scope. Required on scoped list and root-create operations; requests without a resolvable project are rejected with 400. There is no default project.

string

>= 1 characters

Example

00000000-0000-0000-0000-000000000000

Project scope. Required on scoped list and root-create operations; requests without a resolvable project are rejected with 400. There is no default project.

Request Body

Media type application/json

object

name

string

>= 1 characters

description

string

Example ^generated

{
  "name": "example",
  "description": "example"
}

Responses

200

Success

Media type application/json

object

_id

required

string

slug

required

string

name

required

string

description

string

revisionCounter

required

number

latestRevisionId

string

latestRevisionNumber

number

creator

string

createdAt

required

string | null format: date-time

updatedAt

string | null format: date-time

deletedAt

string | null format: date-time

projectId

required

string

Example ^generated

{
  "_id": "example",
  "slug": "example",
  "name": "example",
  "description": "example",
  "revisionCounter": 1,
  "latestRevisionId": "example",
  "latestRevisionNumber": 1,
  "creator": "example",
  "createdAt": "2026-04-15T12:00:00Z",
  "updatedAt": "2026-04-15T12:00:00Z",
  "deletedAt": "2026-04-15T12:00:00Z",
  "projectId": "example"
}

404

Resource not found