Skip to main content
PATCH
Update project overlay

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

id
string<uuid>
required

Project ID

Body

application/json

Only provided fields change; null clears a field.

outcomeTitle
string | null
Maximum string length: 255
outcomeDescription
string | null
Maximum string length: 5000
currentPhase
string | null
Maximum string length: 255
healthStatus
enum<string> | null
Available options:
on_track,
at_risk,
blocked,
completed,
null
healthReason
string | null
Maximum string length: 2000
healthOverride
boolean

Lock the health status against recalculation

mspLeadName
string | null
Maximum string length: 255
mspLeadEmail
string<email> | null
clientSponsorName
string | null
Maximum string length: 255
clientSponsorEmail
string<email> | null
internalNotes
string | null

Never client-visible

Maximum string length: 10000

Response

Overlay updated

data
object
required