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": "<string>",
  "type": "brand",
  "isOwned": true,
  "isPrimary": true,
  "isCompetitor": true,
  "isBlacklisted": true,
  "groupId": "<string>"
}
'

Headers

​
x-project-id
string
required

Project ID to specify the project context

Path Parameters

​
id
string<uuid>
required

Entity ID

Body

application/json
​
name
string

Entity name

​
type
enum<string>

Entity type

Available options:
brand,
person,
company,
other
​
isOwned
boolean

Is this entity owned by the project

​
isPrimary
boolean

Is this the primary entity

​
isCompetitor
boolean

Is this a competitor entity

​
isBlacklisted
boolean

Is this entity blacklisted

​
groupId
string | null

Entity group ID (null to remove)

Response

204 - undefined