> ## Documentation Index
> Fetch the complete documentation index at: https://docs.turncall.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Set Project Redaction

> Turn the project's redaction on or off and choose its entity types
(#313, ADR-0024), replacing the whole setting: `enabled` is required, and
`entities` left out or null is the default list. It applies to what is
stored or sent from then on, a call already live included: at once on the
server that took this request, and within 30 seconds on the others (each
caches the setting that long). What was stored before is not rewritten.
Admin key; a project can only set its own.



## OpenAPI

````yaml /openapi.json put /v1/projects/{project_id}/redaction
openapi: 3.1.0
info:
  title: TurnCall
  description: Production voice agent platform API
  version: 2.0.0
servers: []
security: []
paths:
  /v1/projects/{project_id}/redaction:
    put:
      tags:
        - projects
      summary: Set Project Redaction
      description: >-
        Turn the project's redaction on or off and choose its entity types

        (#313, ADR-0024), replacing the whole setting: `enabled` is required,
        and

        `entities` left out or null is the default list. It applies to what is

        stored or sent from then on, a call already live included: at once on
        the

        server that took this request, and within 30 seconds on the others (each

        caches the setting that long). What was stored before is not rewritten.

        Admin key; a project can only set its own.
      operationId: set_project_redaction_v1_projects__project_id__redaction_put
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Project Id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectRedaction'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: >-
                  Response Set Project Redaction V1 Projects  Project Id 
                  Redaction Put
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ProjectRedaction:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: >-
            Redact this project's calls. Required: a PUT replaces the whole
            setting, so one naming only `entities` must not turn it off
        entities:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Entities
          description: >-
            Entity types to replace (Presidio's names, e.g. PHONE_NUMBER,
            EMAIL_ADDRESS, PERSON). Null = the default: PHONE_NUMBER,
            EMAIL_ADDRESS, CREDIT_CARD, US_SSN, IBAN_CODE
      additionalProperties: false
      type: object
      required:
        - enabled
      title: ProjectRedaction
      description: >-
        A project's redaction (#313, ADR-0024): PII of these entity types is

        replaced in the transcript and every call event before it is stored or

        sent to a webhook. Never in what the agent hears during the call. A
        `PUT`

        replaces the whole setting.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.