---
title: "Updates an example's properties within an audience."
method: PATCH
path: "/audience/{audienceId}/example/{exampleId}"
tags: ["Examples"]
---

# Updates an example's properties within an audience.

`PATCH /audience/{audienceId}/example/{exampleId}`

## Path parameters

- `audienceId` string, required
- `exampleId` string, required

## Request body

- UpdateAudienceExampleEndpointInput — Input model for updating an audience example.
  - `truth` union — The truth for the example.
    - IExampleTruthClassifyExampleTruth
      - `_t` 'ClassifyExampleTruth', required
      - `correctCategories` string[], required
    - IExampleTruthCompareExampleTruth
      - `_t` 'CompareExampleTruth', required
      - `winnerId` string, required
    - IExampleTruthLineExampleTruth
      - `_t` 'LineExampleTruth', required
      - `boundingBoxes` ExampleBoxShape[], nullable
        - `xMin` number, double, nullable
        - `yMin` number, double, nullable
        - `xMax` number, double, nullable
        - `yMax` number, double, nullable
      - `requiredPrecision` number, double, nullable
      - `requiredCompleteness` number, double, nullable
    - IExampleTruthLocateExampleTruth
      - `_t` 'LocateExampleTruth', required
      - `boundingBoxes` ExampleBoxShape[], required
        - `xMin` number, double, nullable
        - `yMin` number, double, nullable
        - `xMax` number, double, nullable
        - `yMax` number, double, nullable
      - `requiredPrecision` number, double, nullable
      - `requiredCompleteness` number, double, nullable
    - IExampleTruthScrubExampleTruth
      - `_t` 'ScrubExampleTruth', required
      - `validRanges` ExampleScrubRange[], required
        - `start` integer, required
        - `end` integer, required
    - IExampleTruthTranscriptionExampleTruth
      - `_t` 'TranscriptionExampleTruth', required
      - `correctWords` ExampleTranscriptionWord[], required
        - `word` string, required
        - `wordIndex` integer, required
      - `strictGrading` boolean, nullable
      - `requiredPrecision` number, double, nullable
      - `requiredCompleteness` number, double, nullable
  - `explanation` string, nullable — The optional explanation that will be shown to the user when answering wrong.
  - `context` string, nullable — An optional text context that will be shown to the user.
  - `contextAsset` union — An optional asset that will be used as context to show to the user.
    - IAssetInputExistingAssetInput
      - `_t` 'ExistingAssetInput', required
      - `name` string, required
      - `metadata` object, nullable
      - `identifier` string, nullable
    - IAssetInputMultiAssetInput
      - `_t` 'MultiAssetInput', required
      - `assets` IAssetInput[], required
        - union
          - object
            - `_t` 'ExistingAssetInput', required
            - `name` string, required
            - `metadata` object, nullable
            - `identifier` string, nullable
          - object
            - `_t` 'MultiAssetInput', required
            - `assets` IAssetInput[], required
            - `metadata` object, nullable
            - `identifier` string, nullable
          - object
            - `_t` 'TextAssetInput', required
            - `text` string, required
            - `metadata` object, nullable
            - `identifier` string, nullable
      - `metadata` object, nullable
      - `identifier` string, nullable
    - IAssetInputTextAssetInput
      - `_t` 'TextAssetInput', required
      - `text` string, required
      - `metadata` object, nullable
      - `identifier` string, nullable
  - `randomCorrectProbability` number, double, nullable — The probability that if the user answers at random that they'll be correct.
  - `isCommonSense` boolean, nullable — Whether this example should be treated as commonsense validation.
  - `sortIndex` integer — The sort index that controls the serving order of this example.
  - `visibility` 'Private' | 'Public'

## Response `204`

No Content

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Forbidden

---

[API](https://skmtc.net/rapidata/apis/rapidata-api.md) · [All operations](https://skmtc.net/rapidata/apis/rapidata-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapidata/rapidata-api/revisions/e42ec51c7b88/schema)