PUT
/
api
/
v1
/
admin
/
simulation
/
team-sessions
/
analytics
/
snapshots
/
{snapshot_id}
/
share-controls
Update Team Simulation Benchmark Snapshot Share Controls
curl --request PUT \
  --url https://api.jobsim.work/api/v1/admin/simulation/team-sessions/analytics/snapshots/{snapshot_id}/share-controls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "share_status": "<string>",
  "share_expires_at": "2023-11-07T05:31:56Z",
  "regenerate_share_token": false,
  "metadata": {}
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

snapshot_id
string
required

Body

application/json

Request payload to update snapshot share governance controls.

share_status
string | null
share_expires_at
string<date-time> | null
regenerate_share_token
boolean
default:false
metadata
Metadata · object

Response

Successful Response