Skip to content

Save Onboarding Charter

PUT
/api/v1/onboarding/charter
curl --request PUT \
--url https://api.ultimateteam.ai/api/v1/onboarding/charter \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "brand_voice_strictness": "strict", "communication_autonomy": "autonomous", "competitor_sensitivity": "aggressive", "financial_auth_limit": 1, "risk_tolerance": "conservative" }'
Media typeapplication/json
TenantConstitutionUpdateRequest

Owner-supplied values for the five charter dimensions.

object
brand_voice_strictness
required
Brand Voice Strictness
string
Allowed values: strict flexible creative
communication_autonomy
required
Communication Autonomy
string
Allowed values: autonomous review-first approval-required
competitor_sensitivity
required
Competitor Sensitivity
string
Allowed values: aggressive neutral defensive
financial_auth_limit
required
Financial Auth Limit
number
risk_tolerance
required
Risk Tolerance
string
Allowed values: conservative moderate aggressive

Successful Response

Media typeapplication/json
TenantConstitutionResponse

The tenant-wide Standing Operating Charter (one row per tenant).

object
acknowledgement
Any of:
object
key
additional properties
any
brand_voice_strictness
required
Brand Voice Strictness
string
communication_autonomy
required
Communication Autonomy
string
competitor_sensitivity
required
Competitor Sensitivity
string
configured
required
Configured
boolean
dispatch_pending
Dispatch Pending
boolean
financial_auth_limit
required
Financial Auth Limit
number
risk_tolerance
required
Risk Tolerance
string
updated_at
required
Any of:
string format: date-time
Example
{
"dispatch_pending": false
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}