Skip to main content
PATCH
/
api
/
v1
/
projects
/
{id}
Update a project
curl --request PATCH \
  --url https://api.mentionlab.io/api/v1/projects/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "name": "My Project",
  "description": "My Project Description",
  "website": "https://www.mentionlab.io",
  "industry": "Cosmetics",
  "nameAliases": [
    "My Project",
    "My Project 2"
  ],
  "blackListAliases": [
    "Other Brand",
    "Unrelated Company"
  ],
  "recurrence": "0 1 1 * *",
  "recurrenceTimezone": "Europe/Brussels",
  "recurrenceStatus": "active",
  "llmProviders": [
    "gpt-4.1-mini",
    "claude-haiku-4-5",
    "gemini-2.5-flash"
  ],
  "executionCount": 3,
  "currentPo": "PO-2026-Q2-1234"
}
'

Headers

​
x-project-id
string
required

Project ID to specify the project context

Path Parameters

​
id
string
required

Identifier of the project to update. Must match the x-project-id header.

Example:

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

Body

application/json
​
name
string

The name of the project

Example:

"My Project"

​
description
string

The description of the project

Example:

"My Project Description"

​
website
string

The website of the project

Example:

"https://www.mentionlab.io"

​
industry
string

The industry of the project

Example:

"Cosmetics"

​
nameAliases
string[]

The aliases of the project name

Example:
["My Project", "My Project 2"]
​
blackListAliases
string[]

The blacklisted aliases of the project name

Example:
["Other Brand", "Unrelated Company"]
​
recurrence
string

The recurrence of the project, either a CRON expression or "manual"

Example:

"0 1 1 * *"

​
recurrenceTimezone
string

The timezone for the recurrence cron expression, as a valid IANA timezone string

Example:

"Europe/Brussels"

​
recurrenceStatus
enum<string>

The recurrence status of the project

Available options:
active,
paused
Example:

"active"

​
llmProviders
enum<string>[]

The AI models to use for the project

Available options:
gpt-4.1-mini,
gpt-5-mini,
gpt-5-chat-latest,
gpt-5.1-chat-latest,
gpt-5.2-chat-latest,
gpt-5.3-chat-latest,
chat-latest,
claude-haiku-4-5,
gemini-2.5-flash,
gemini-3-flash-preview,
sonar,
deepseek-v3.2-maas,
ai-overview,
ai-mode,
scp-ml-chatgpt,
scp-ml-google-ai-mode,
scp-ml-gemini
Example:
[
  "gpt-4.1-mini",
  "claude-haiku-4-5",
  "gemini-2.5-flash"
]
​
executionCount
number

The execution count of the project

Example:

3

​
currentPo
string

Active purchase order. When set, future buys / refunds / commitment releases that target this project snapshot the value onto the resulting lot for accountant statements.

Example:

"PO-2026-Q2-1234"

Response