Skip to main content
POST
Create a project

Path Parameters

organisationId
string<uuid>
required

Body

application/json
name
string
required

Display name; needs two letters or digits

Maximum string length: 100
Example:

"Acme"

website
string

The website of the entity the project tracks, stored as entered

Example:

"https://www.mentionlab.io"

industry
string

Sector the project competes in

Example:

"Cosmetics"

description
string

Free text about what the project covers

Example:

"Skincare and haircare lines sold in Europe"

entityType
enum<string>

What the project tracks, brands when absent. A change applies to new answers only

Available options:
brands,
brands_and_products,
countries_cities,
organisations,
people,
places,
facilities,
events
Example:

"countries_cities"

analysisInstructions
string | null

Extra instructions for the analysis of the project's answers, for new answers only; an empty string clears them

Maximum string length: 500
Example:

"Do not count retailers or marketplaces as brands."

themeAnalysisEnabled
boolean

Turns on the theme analysis of the project's answers; the organisation's plan must include it

Example:

true

themeLanguage
enum<string>

The themes' language; auto lets each theme follow its answer

Available options:
auto,
en,
fr,
nl,
de,
es,
it,
pt
Example:

"auto"

Response

id
string<uuid>
required

Uuid of the project, the id every project-scoped route takes

name
string
required

Display name; the slug does not follow a later rename

slug
string
required

URL segment

entityType
enum<string>
required

What the project tracks; the entity-types list gives its labels

Available options:
brands,
brands_and_products,
countries_cities,
organisations,
people,
places,
facilities,
events
analysisInstructions
string | null
required

Extra instructions added to the analysis of the project's answers

themeAnalysisEnabled
boolean
required

Whether the project's answers get a theme analysis

Example:

false

themeLanguage
enum<string>
required

The themes' language; auto lets each theme follow its answer

Available options:
auto,
en,
fr,
nl,
de,
es,
it,
pt
Example:

"en"

queryCount
number
required

Queries the project tracks

permissions
enum<string>[]
required

What the caller may do in the project

Available options:
project:read,
project:write,
project:delete,
project:manage_members,
stats:read
customFilters
object[]
required

The filters pinned for the project, in order

website
string

As entered, e.g. https://www.mentionlab.io

industry
string

Sector the project competes in

description
string

Free text about what the project covers

role
enum<string>

The caller's role in the project; absent unless it is a member, so always absent for an API key

Available options:
project_manager,
project_editor,
project_viewer