Update Entity

Authorization

API Key

x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

id*string

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status?string

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).

Value in"approved" | "rejected"

assignedTypeID?string

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

canonical?string

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

addSynonyms?array<>

Surface forms to attach as customer_defined synonyms.

removeSynonymIDs?array<>

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

locale?string

Optional BCP 47 locale tag stamped on any added synonyms.

Response Body

`application/json`

curl -X PATCH "https://api.bem.ai/v3/entities/string" \  -H "Content-Type: application/json" \  -d '{    "status": "approved"  }'

{
  "entityID": "string",
  "canonical": "string",
  "type": "string",
  "description": "string",
  "mentionCount": 0,
  "surfaceForms": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "status": "extracted",
  "typeID": "string",
  "validatedAt": "2019-08-24T14:15:22Z",
  "validatedByUserID": "string"
}