Skip to main content
PATCH
/
api
/
entities
/
{id}
Update an entity
curl --request PATCH \
  --url https://api.mentionlab.io/api/entities/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "name": "Acme Corporation",
  "type": "brand",
  "isOwned": true,
  "isPrimary": false,
  "isCompetitor": false,
  "isBlacklisted": false,
  "groupId": "3f9a8b2c-1d4e-4f6a-9b8c-7d6e5f4a3b2c"
}
'

Headers

​
x-project-id
string
required

Project ID to specify the project context

Path Parameters

​
id
string<uuid>
required

The UUID of the entity to update.

Body

application/json
​
name
string

Display name of the entity

Example:

"Acme Corporation"

​
type
enum<string>

Type/category of the entity

Available options:
brand,
person,
company,
other
Example:

"brand"

​
isOwned
boolean

Whether this entity belongs to (is owned by) the current project

Example:

true

​
isPrimary
boolean

Whether this entity is the project's primary entity

Example:

false

​
isCompetitor
boolean

Whether this entity is tracked as a competitor

Example:

false

​
isBlacklisted
boolean

Whether this entity is blacklisted and should be excluded from tracking

Example:

false

​
groupId
string | null

UUID of the entity group to assign this entity to. Pass null to remove the entity from its current group.

Example:

"3f9a8b2c-1d4e-4f6a-9b8c-7d6e5f4a3b2c"

Response