Skip to content
UltimateTeam.ai Docs

Put Participation

PUT
/api/v1/collective/participation
curl --request PUT \
  --url https://api.ultimateteam.ai/api/v1/collective/participation \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "enabled": true, "industry": "example", "metric_names": [ "example" ], "policy_version": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ParticipationRequest
object
enabled
required
Enabled
boolean
industry
required
Industry
string
metric_names
required
Metric Names
Array<string>
<= 12 items
policy_version
required
Policy Version
string
Examplegenerated
{
  "enabled": true,
  "industry": "example",
  "metric_names": [
    "example"
  ],
  "policy_version": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
ParticipationResponse
object
consent
required
Any of:
ConsentResponse
object
accepted_at
required
Accepted At
string format: date-time
enabled
required
Enabled
boolean
industry
required
Industry
string
last_published_at
required
Any of:
string format: date-time
metric_names
required
Metric Names
Array<string>
policy_version
required
Policy Version
string
withdrawn_at
required
Any of:
string format: date-time
dispatch_pending
Any of:
boolean
observations
required
Observations
Array<object>
ObservationResponse
object
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
metric_name
required
Metric Name
string
metric_value
required
Metric Value
number
metric_variant
required
Metric Variant
string
period
required
Period
string
policy_version
required
Policy Version
string
request_id
required
Request Id
string format: uuid
source_kind
required
Source Kind
string
Allowed values: owner_attested native_receipt
unit
required
Unit
string
window_end
required
Window End
string format: date
window_start
required
Window Start
string format: date
Example
{
  "observations": [
    {
      "source_kind": "owner_attested"
    }
  ]
}

422

Section titled “422”

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"
    }
  ]
}