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

# Editar canal

> Altera o nome e a descrição do canal. Envie apenas os campos que mudam.

## Resposta

| Campo | Descrição |
| - | - |
| `id` | ID do canal |
| `name` | Nome do canal |
| `description` | Descrição do canal |


## OpenAPI

````yaml api-reference/administracao/specs/canais.json PATCH /channels/whatsapp/{id}
openapi: 3.1.0
info:
  title: Datafy API — Administração de canais
  version: 1.0.0
servers:
  - url: https://cloud.datafyapi.com.br
    description: Produção
security:
  - tokenDeConta: []
paths:
  /channels/whatsapp/{id}:
    patch:
      summary: Editar canal
      description: Altera o nome e a descrição do canal. Envie apenas os campos que mudam.
      operationId: editarCanal
      parameters:
        - $ref: '#/components/parameters/CanalId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: Atendimento
                  description: Novo nome do canal. Não pode ser vazio.
                description:
                  type: string
                  example: Canal do suporte
                  description: Nova descrição do canal.
            example:
              name: Atendimento
              description: Canal do suporte
      responses:
        '200':
          description: Canal editado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID do canal.
                  name:
                    type: string
                    description: Nome do canal.
                  description:
                    type:
                      - string
                      - 'null'
                    description: Descrição do canal.
              example:
                id: 96c3df7e-300c-47de-bfaf-7d2a2899bd19
                name: Atendimento
                description: Canal do suporte
        '400':
          description: Nenhum campo enviado, ou name vazio.
          content:
            application/json:
              examples:
                sem_campos:
                  summary: Nenhum campo enviado
                  value:
                    statusCode: 400
                    message: Envie "name" e/ou "description" para editar
                nome_vazio:
                  summary: name vazio
                  value:
                    statusCode: 400
                    message: O nome do canal (name) não pode ser vazio
        '401':
          $ref: '#/components/responses/NaoAutorizado'
        '403':
          $ref: '#/components/responses/AssinaturaInativa'
        '404':
          $ref: '#/components/responses/CanalNaoEncontrado'
components:
  parameters:
    CanalId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: ID do canal, retornado em Listar canais e em Criar canal.
  responses:
    NaoAutorizado:
      description: Token de conta ausente ou inválido.
      content:
        application/json:
          example:
            statusCode: 401
            message: Token de conta ausente ou inválido
    AssinaturaInativa:
      description: A assinatura da conta não está ativa.
      content:
        application/json:
          example:
            statusCode: 403
            message: >-
              Sua assinatura precisa estar ativa para usar a API. Acesse o
              painel para ativá-la.
    CanalNaoEncontrado:
      description: Canal inexistente ou de outra conta.
      content:
        application/json:
          example:
            statusCode: 404
            message: Canal não encontrado
  securitySchemes:
    tokenDeConta:
      type: http
      scheme: bearer
      description: >-
        Token de conta gerado no painel da Datafy, em Perfil. Formato:
        `sk_acct_xxx`. Diferente do token de canal (`sk_live_`).

````

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