Skip to main content
POST
/
api
/
entities
Create a new entity
curl --request POST \
  --url https://api.mentionlab.io/api/entities \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "name": "Samsung",
  "type": "brand",
  "isOwned": true,
  "isPrimary": true,
  "isCompetitor": true,
  "isBlacklisted": true,
  "groupId": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "type": "brand",
  "isOwned": true,
  "isPrimary": true,
  "isCompetitor": true,
  "isBlacklisted": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "group": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>"
  },
  "canonicalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Headers

x-project-id
string
required

Project ID to specify the project context

Body

application/json
name
string
required

Entity name

Example:

"Samsung"

type
enum<string>
default:brand

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

Entity group ID

Response

201 - application/json
id
string<uuid>
required
name
string
required
slug
string
required
type
enum<string>
required
Available options:
brand,
person,
company,
other
isOwned
boolean
required
isPrimary
boolean
required
isCompetitor
boolean
required
isBlacklisted
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
group
object
canonicalId
string<uuid>