> ## 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.

# Cancelar assinatura do canal

> Cancela a assinatura do canal. O crédito proporcional entra no próximo ciclo.

Cancelar um canal reduz em um a quantidade cobrada na [assinatura da conta](https://developers.datafyapi.com.br/api-reference/administracao/assinar-canal.md#como-funciona-a-cobrança). O crédito proporcional aos dias restantes entra no próximo ciclo.

Cancelar um canal que já está inativo não altera nada e devolve a mesma resposta.

> [!WARNING]
>
> Não é possível cancelar o último canal ativo pela API, porque isso encerraria a assinatura da conta. A resposta é `409`, e o encerramento é feito no [painel da Datafy](https://app.datafyapi.com.br).

## Resposta

| Campo | Descrição |
| - | - |
| `id` | ID do canal |
| `subscribed` | Situação da assinatura do canal |


## OpenAPI

````yaml api-reference/administracao/specs/canais.json POST /channels/whatsapp/{id}/cancel
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}/cancel:
    post:
      summary: Cancelar canal
      description: >-
        Cancela a assinatura do canal. O crédito proporcional entra no próximo
        ciclo.
      operationId: cancelarCanal
      parameters:
        - $ref: '#/components/parameters/CanalId'
      responses:
        '200':
          description: Situação da assinatura do canal.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID do canal.
                  subscribed:
                    type: boolean
                    description: Situação da assinatura do canal.
              example:
                id: 96c3df7e-300c-47de-bfaf-7d2a2899bd19
                subscribed: false
        '401':
          $ref: '#/components/responses/NaoAutorizado'
        '403':
          $ref: '#/components/responses/AssinaturaInativa'
        '404':
          $ref: '#/components/responses/CanalNaoEncontrado'
        '409':
          description: É o único canal ativo da conta.
          content:
            application/json:
              example:
                statusCode: 409
                message: >-
                  Este é seu único canal ativo. Para encerrar a assinatura,
                  cancele pelo painel.
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.