Sign in
Entity Curation

Update Entity

patch/v3/entities/{id}

Path parameters

idstring required

Entity public ID (ent_...). A merged-away id resolves to its survivor.

Query parameters

bucketstring

Optional bucket public ID (bkt_...) to scope the lookup to. Omit for the default bucket.

Request body

status'approved' | 'rejected'

Transition the entity's curation status. Only approved or rejected are accepted, and only from extracted or proposed (any other transition is rejected with 409).

assignedTypeIDstring

The ety_... public ID of the type to assign (overriding the bem-inferred type). The empty string clears the assignment. Omit to leave unchanged.

canonicalstring

Replace the entity's canonical surface form (re-derives its normalized form).

addSynonymsstring[]

Surface forms to attach as customer_defined synonyms.

removeSynonymIDsstring[]

esn_... synonym IDs to soft-delete. Only customer_defined / sme_approved synonyms may be removed; an extracted synonym is rejected with 409.

localestring

Optional BCP 47 locale tag stamped on any added synonyms.

Response

The request has succeeded.

entityIDstring required

Public ID (ent_...).

canonicalstring required

The canonical (longest / most descriptive) surface form.

typestring required

The entity's effective type name (assigned type if set, else inferred).

descriptionstring

Free-form description.

mentionCountinteger required

Total mentions across parsed documents.

surfaceFormsstring[] required

Distinct surface forms resolved to this entity.

createdAtstring date-time required

Creation timestamp.

updatedAtstring date-time required

Last-update timestamp.

status'extracted' | 'proposed' | 'approved' | 'rejected' required

Curation lifecycle state.

typeIDstring

ety_... public ID of the assigned type, when one is set.

validatedAtstring date-time

When the entity was approved/rejected. Present only once validated.

validatedByUserIDstring

usr_... public ID of the validating user (dashboard transitions only).

Changes