Skip to main content
POST
Create a new entity

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

Example:

true

isPrimary
boolean

Is this the primary entity

Example:

false

isCompetitor
boolean

Is this a competitor entity

Example:

false

isBlacklisted
boolean

Is this entity blacklisted

Example:

false

groupId
string

Entity group ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

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
domains
object[]
required

Domains mapped to this entity (project-scoped).

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
group
object
canonicalId
string<uuid>