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

# Update a channel

> Update a channel. Fields you leave out keep their value. Needs the `channels:write` permission.



## OpenAPI

````yaml put /channels/{id}
openapi: 3.1.0
info:
  title: Moderation API
  description: API for automated content moderation
  version: 1.1.0
servers:
  - url: https://api.moderationapi.com/v1
security: []
tags:
  - name: Actions
  - name: Queues
  - name: Webhooks
  - name: Wordlist
  - name: UserReports
  - name: Projects
  - name: Channels
  - name: Voice
    description: Real-time voice moderation over WebSocket.
externalDocs:
  url: https://docs.moderationapi.com
paths:
  /channels/{id}:
    put:
      tags:
        - Channels
      summary: Update a channel
      description: >-
        Update a channel. Fields you leave out keep their value. Needs the
        `channels:write` permission.
      operationId: management-channels-update
      parameters:
        - in: path
          name: id
          schema:
            type: string
            description: The ID of the channel to update.
          required: true
          description: The ID of the channel to update.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                  description: The channel's name.
                key:
                  description: >-
                    The key you pass as `channel` when you moderate content.
                    Changing it breaks integrations that send the old key.
                  type: string
                  minLength: 1
                  maxLength: 100
                  pattern: ^[A-Za-z0-9_-]+$
                description:
                  description: The channel's description.
                  anyOf:
                    - type: string
                      maxLength: 500
                    - type: 'null'
                contentType:
                  type: string
                  enum:
                    - profile
                    - message
                    - post
                    - comment
                    - event
                    - product
                    - review
                    - voice
                    - other
                  description: The kind of content the channel moderates.
                flaggingMode:
                  type: string
                  enum:
                    - DRY_RUN
                    - ACTIVE
                  description: >-
                    `ACTIVE` flags content. `DRY_RUN` evaluates content without
                    flagging it.
                contextEnabled:
                  type: boolean
                  description: >-
                    Whether earlier messages in the conversation are read when
                    moderating a message.
                enableImageModeration:
                  type: boolean
                  description: Whether images are moderated.
                enableVideoModeration:
                  type: boolean
                  description: Whether videos are moderated.
                enableAudioModeration:
                  type: boolean
                  description: Whether audio is moderated.
                enableVoiceModeration:
                  type: boolean
                  description: Whether real-time voice streams are moderated.
                includeTranscriptInResponse:
                  type: boolean
                  description: >-
                    Whether audio and video transcripts are returned in
                    responses.
                transcriptionQuality:
                  type: string
                  enum:
                    - SPEED
                    - BALANCED
                    - ACCURACY
                  description: Trade-off between transcription speed and accuracy.
                unicodeSpoofDetectionEnabled:
                  type: boolean
                  description: >-
                    Whether look-alike Unicode characters are normalized before
                    moderation.
                frameCaptureInterval:
                  type: number
                  minimum: 0.1
                  maximum: 60
                  description: Seconds between frames captured from a video.
                maxFramesPerVideo:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  description: The most frames moderated per video.
                spreadFrames:
                  type: boolean
                  description: Whether frames are spread evenly across the whole video.
      responses:
        '200':
          description: Channel updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
      security:
        - Authorization: []
components:
  schemas:
    Channel:
      type: object
      properties:
        id:
          type: string
          description: The ID of the channel.
        projectId:
          type: string
          description: The ID of the project the channel is in.
        key:
          type: string
          description: >-
            The key you pass as `channel` when you moderate content. Unique in
            the project.
        name:
          type: string
          description: The channel's name.
        description:
          description: The channel's description.
          type:
            - string
            - 'null'
        isDefault:
          type: boolean
          description: >-
            Whether requests that name no channel use this one. Each project has
            one default channel.
        contentType:
          anyOf:
            - type: string
              enum:
                - profile
                - message
                - post
                - comment
                - event
                - product
                - review
                - voice
                - other
              description: The kind of content the channel moderates.
            - type: 'null'
        flaggingMode:
          type: string
          enum:
            - DRY_RUN
            - ACTIVE
          description: >-
            `ACTIVE` flags content. `DRY_RUN` evaluates content without flagging
            it.
        contextEnabled:
          type: boolean
          description: >-
            Whether earlier messages in the conversation are read when
            moderating a message.
        enableImageModeration:
          type: boolean
          description: Whether images are moderated.
        enableVideoModeration:
          type: boolean
          description: Whether videos are moderated.
        enableAudioModeration:
          type: boolean
          description: Whether audio is moderated.
        enableVoiceModeration:
          type: boolean
          description: Whether real-time voice streams are moderated.
        includeTranscriptInResponse:
          type: boolean
          description: Whether audio and video transcripts are returned in responses.
        transcriptionQuality:
          type: string
          enum:
            - SPEED
            - BALANCED
            - ACCURACY
          description: Trade-off between transcription speed and accuracy.
        unicodeSpoofDetectionEnabled:
          type: boolean
          description: >-
            Whether look-alike Unicode characters are normalized before
            moderation.
        frameCaptureInterval:
          type: number
          minimum: 0.1
          maximum: 60
          description: Seconds between frames captured from a video.
        maxFramesPerVideo:
          type: integer
          minimum: 1
          maximum: 1000
          description: The most frames moderated per video.
        spreadFrames:
          type: boolean
          description: Whether frames are spread evenly across the whole video.
        createdAt:
          description: When the channel was created.
          type: string
        updatedAt:
          description: When the channel was last changed.
          type: string
      required:
        - id
        - projectId
        - key
        - name
        - description
        - isDefault
        - contentType
        - flaggingMode
        - contextEnabled
        - enableImageModeration
        - enableVideoModeration
        - enableAudioModeration
        - enableVoiceModeration
        - includeTranscriptInResponse
        - transcriptionQuality
        - unicodeSpoofDetectionEnabled
        - frameCaptureInterval
        - maxFramesPerVideo
        - spreadFrames
        - createdAt
        - updatedAt
      additionalProperties: false
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.NOT_FOUND:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Not found
        code:
          type: string
          description: The error code
          example: NOT_FOUND
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Not found error (404)
      description: The error information
      example:
        code: NOT_FOUND
        message: Not found
        issues: []
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````