Skip to content
UltimateTeam.ai Docs

Update consent status

PATCH
/api/v1/content/case-studies/{study_id}/consent
curl --request PATCH \
  --url https://api.ultimateteam.ai/api/v1/content/case-studies/example/consent \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "consent_status": "example" }'

Update the consent status of a case study.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
study_id
required
Study Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CaseStudyConsentUpdate

Request body for updating a case study’s consent status.

object
consent_status
required
Consent Status
string
<= 30 characters
Examplegenerated
{
  "consent_status": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
CaseStudyResponse

Response body for a single case study.

object
anonymization_level
required
Anonymization Level
string
consent_status
required
Consent Status
string
content
Content
object
key
additional properties
any
created_at
required
Created At
string format: date-time
id
required
Id
string
metrics_snapshot
Metrics Snapshot
object
key
additional properties
any
published_at
Any of:
string format: date-time
source_tenant_id
required
Source Tenant Id
string
status
required
Status
string
template_type
required
Template Type
string
tenant_id
required
Tenant Id
string
title
required
Title
string
updated_at
required
Updated At
string format: date-time
Examplegenerated
{
  "anonymization_level": "example",
  "consent_status": "example",
  "content": {},
  "created_at": "2026-04-15T12:00:00Z",
  "id": "example",
  "metrics_snapshot": {},
  "published_at": "2026-04-15T12:00:00Z",
  "source_tenant_id": "example",
  "status": "example",
  "template_type": "example",
  "tenant_id": "example",
  "title": "example",
  "updated_at": "2026-04-15T12:00:00Z"
}

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