Update a project

patch
https://api.clakta.com/v1/projects/{idOrSlug}

Update a project's settings. Requires an API key with `projects.write`. Send only the fields you want to change.

Changing `currency` converts the revenue thresholds of the project's dashboard widgets at the current exchange rate. Changing `slug` changes the value you address the project by. `dataRetentionDays` cannot exceed the team plan's retention limit.

Autenticação

Envie sua chave de API como bearer token no cabeçalho Authorization.

Veja Autenticação para saber como criar uma chave de API e definir seus escopos.

Parâmetros de rota

idOrSlugstringobrigatório

The project ID (with the proj_ prefix) or slug.

Corpoapplication/json

namestringopcional

The name of the project, up to 32 characters.

slugstringopcional

The slug of the project, unique within the team. Between 3 and 48 characters, normalized to lowercase letters, numbers and hyphens.

iconstring | nullopcional

The icon of the project, as ":EMOJI_NAME:" or "ph:ICON_NAME". null removes it.

currencystringopcional

The ISO 4217 currency code the project reports revenue and ad spend in.

trackingModeenum<string>opcional

How visitor data is collected: privacy_friendly (no cookies, server-estimated sessions) or full_attribution (cookies/first-party identifiers).

Valores aceitos:privacy_friendlyfull_attribution

attributionModelenum<string>opcional

Attribution model used to credit Clakta-tracked ad touchpoints when computing Clakta-specific ad metrics. Does not affect platform-reported metrics.

Valores aceitos:LAST_CLICKFIRST_CLICKLINEAR_ALLLINEAR_PAIDTRIPLE_ATTRIBUTION

dataRetentionDaysinteger | nullopcional

How many days of events/analytics stay available in dashboards and reports. null = the team plan's retention limit.

aiColumnsEnabledbooleanopcional

Whether the AI-backed ads manager columns may run for this project.

adsRevenueIncludesRenewalsbooleanopcional

Whether subscription renewals count toward the ad revenue of the campaign that acquired the subscriber.

Resposta

The updated project

messagestringobrigatório
dataobjectobrigatório