Skip to main content
PATCH
Update a research project's settings.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

projectId
string
required

Body

application/json

Fields to update; only supplied fields change

Fields to update on an existing research project. Only supplied fields change.

companyId
string
required

Company ID that owns the project

competitorDomains
string[]

Replacement competitor domain list

domain
string

New domain to research

frequency
enum<string>

How often the project auto-runs. One of: manual, weekly, monthly.

Available options:
manual,
weekly,
monthly
idealCustomerProfileId
string

ICP to target

name
string

New project name

seedKeywords
string[]

Replacement seed keyword list

status
enum<string>

Project status. One of: active, archived.

Available options:
active,
archived

Response

The updated project

A single research project

project
object

The project

success
boolean

Whether the operation succeeded