Skip to main content
PATCH
Update Entity
Updates the fields of an existing entity. Only the fields you include in the request body are updated — omitted fields are left unchanged. Only the entity’s author, or a request with a service or master key, can update an entity. Authentication required.

Path Parameters

string
required
The UUID of the entity to update.

Body Parameters

string
New title for the entity.
string
New content body for the entity.
object[]
Replaces the entity’s attachments array with the provided value.
string[]
Replaces the entity’s keywords array.
object[]
Replaces the entity’s mentions array. Each item is:
  • { type: "user", id: string, username: string, foreignId?: string }
  • { type: "space", id: string, slug: string }
object
New geographic coordinates:
object
Replaces the entity’s metadata object entirely.

Response

Returns the updated Entity object, populated with the author’s user profile.
If title or content changed, the entity’s semantic search embeddings are automatically re-queued for projects with AI search enabled.

Error Responses