Skip to main content
PATCH
Update Project

Authorizations

Authorization
string
header
required

Team API key created in Team Settings. Use it with URLs for the same team.

Path Parameters

project
string<uuid>
required

Project UUID.

Body

application/json

Partial update. Only the fields present are applied.

name
string
Maximum string length: 255
check_frequency
enum<string>
Available options:
manual,
monthly,
weekly,
daily
default_country_code
string

ISO 3166-1 alpha-2 code of an active country.

prompt_limit
integer | null
Required range: 1 <= x <= 1000
services
string[]

Replaces the monitored services. Each entry may be either a service UUID or provider slug such as chatgpt or perplexity.

Minimum array length: 1
primary_brand
object

Primary brand changes. name is required whenever primary_brand is supplied; domain and aliases are optional.

Response

The updated project.

uuid
string<uuid>
required
name
string
required
check_frequency
enum<string>
required
Available options:
manual,
monthly,
weekly,
daily
project_type
enum<string>
required

Project type. pitch projects run a fixed 7-day collection window and do not consume credits.

Available options:
standard,
pitch
pitch_ends_at
string<date-time> | null
required

End of the 7-day pitch collection window. Only set for pitch projects once their first collection run starts; always null for standard projects. Read-only.

prompt_limit
integer
required

Resolved prompt limit. Falls back to the team default when not explicitly set on the project.

archived_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
default_country
object | null
required
primary_brand
object | null
required
services
object[]
required

Active services (AI platforms) enabled for this project.

share
object
required