Update an existing project

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/update

Modifies the settings of an existing project. This can include changing its name, global JavaScript, time zone, active domains, integration settings, or GDPR compliance options. The list of domains provided in the request will replace the existing list.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

Body Params

Contains the fields of the project to be updated. Any domains provided will replace the existing list. Other modifiable fields include name, global_javascript, reporting_settings, settings (like time zone, jQuery inclusion, GDPR options), and integrations_settings.

global_javascript

string | null

Custom JavaScript code that will be included on all pages where this project's tracking script is installed. This script runs before any experience-specific code, making it suitable for global helper functions, third-party integrations setup (like analytics), or defining global variables. KB: "Project, Experience, Variation Javascript" - "Global Project JavaScript".

name

string

length ≤ 200

A user-defined, friendly name for the project (e.g., "Main Website Optimization", "Q3 Marketing Campaigns", "Mobile App Features").

project_type

string

enum

Defaults to web

The type of project, determining its capabilities and how it's used:

web: For traditional website A/B testing, MVT, Split URL, personalization, and deploys using the client-side JavaScript tracking snippet.
fullstack: For server-side experiments, feature flagging, and mobile app testing using Convert's Full Stack SDKs. KB: "Full Stack Experiments on Convert".

Allowed:

reporting_settings

object

Comprehensive settings governing how an experience's results are reported and analyzed.

settings

object

General operational settings for the project.

integrations_settings

object

Project-wide settings for various third-party integrations (e.g., Google Analytics, Crazy Egg, Hotjar). Experience-level settings can sometimes override these.

status

string

enum

The overall status of a project:

active: The project is active, and experiences within it can run and track data.
inactive: The project is inactive (archived or paused). No experiences within it will run, and no new data will be tracked.
suspended: The project (or account) has been suspended, typically due to billing issues or terms of service violations. Services are disabled.

Allowed:

custom_domain

object | null

Configuration for using a custom domain (CNAME) to serve the Convert tracking script and receive tracking data. This can improve branding and potentially reduce issues with ad blockers or third-party cookie restrictions. Requires DNS setup.

environments

object

A user-defined map of environments for this project (e.g., "production", "staging", "development"). Each environment has its own variant of the tracking script. Experiences are typically configured to run in a specific environment. The number of allowed environments depends on the account's subscription plan. KB: "The Environments Feature".

default_goals

array of objects

A list of Goal IDs that will be automatically added to any new experience created within this project.

default_goals

default_audiences

array of objects

A list of Audience IDs that will be automatically added to any new experience created within this project.

default_audiences

default_locations

array of objects

A list of Location IDs that will be automatically added to any new experience created within this project.

default_locations

domains

array of objects

The list of domains included in this project. If a domain ID is provided, that domain will just be updated.

Otherwise the domain will be created.

Caution: Any domain not in the provided list would be deleted from the project

domains

include

array of objects

Specifies optional related data fields to include for each project in the list. Refer to the Optional Fields section.

include

expand

array of objects

Specifies linked objects to expand for each project in the list. Refer to the Expanding Fields section.

expand

Responses

201Detailed information for a single project, including its settings, associated domains, default goals/audiences/locations, integrations, and usage statistics (if requested via include).

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.