Skip to main content
PUT
Set Traffic Light Purple flag

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

companyId
string<uuid>
required

Company ID

Body

application/json
active
boolean
required

false removes the flag

details
object
approvedBy
string<uuid>

userId from the staff endpoint

note
string

Rationale; required to remove the flag

Maximum string length: 4000

Response

Purple flag set or removed

data
object
required