Skip to main content
PATCH
TypeScript

Authorizations

Authorization
string
header
required

Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.

Path Parameters

projectId
string
required

The unique identifier of the project to update.

Body

application/json

Fields to update.

Project identity, limit, and tracking fields to replace; omitted fields remain unchanged.

limits
ProjectLimitsModel · object

Complete replacement for the project's operational limits.

name
string

Replacement project name.

slug
string

Replacement project slug.

trackingSettings
ProjectTrackingSettingsModel · object

Complete replacement for project-level tracking defaults.

Response

Updated project.

createdAt
string
required
id
string
required
limits
ProjectLimitsModel · object
required

Operational limits applied to the project. Supply every field when replacing limits.

name
string
required
region
string
required
slug
string
required
status
string
required
trackingSettings
ProjectTrackingSettingsModel · object
required

Project defaults for email tracking. Supply every field except scrollDepth when replacing settings.

updatedAt
string
required
suspensionReason
string