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

# Criar canal

> Cria um canal de comunicação, que depois é conectado ao WhatsApp.

> [!NOTE]
>
> O canal pode ser usado por **2 dias** sem assinatura, para testes. Depois desse prazo é preciso [assinar o canal](https://developers.datafyapi.com.br/api-reference/administracao/assinar-canal.md) para ele voltar a funcionar. O fim do prazo vem em `trial_ends_at`, retornado em [Consultar canal](https://developers.datafyapi.com.br/api-reference/administracao/consultar-canal.md).

## Resposta

| Campo | Descrição |
| - | - |
| `id` | ID do canal |
| `name` | Nome dado ao canal |
| `description` | Descrição dada ao canal |
| `token` | Token do canal (`sk_live_`), usado nas requisições da API do WhatsApp deste canal |
| `webhook_secret` | Segredo usado na [assinatura](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/validar-assinatura.md) de todos os webhooks deste canal |
| `subscribed` | Situação da assinatura do canal. Sempre `false` na criação |


## OpenAPI

````yaml api-reference/administracao/specs/canais.json POST /channels/whatsapp
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:
    post:
      summary: Criar canal
      description: Cria um canal de comunicação, que depois é conectado ao WhatsApp.
      operationId: criarCanal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  example: Atendimento
                  description: Nome do canal.
                description:
                  type: string
                  example: Canal do suporte
                  description: Descrição do canal. Opcional.
            example:
              name: Atendimento
              description: Canal do suporte
      responses:
        '200':
          description: Canal criado.
          content:
            application/json:
              example:
                id: 96c3df7e-300c-47de-bfaf-7d2a2899bd19
                name: Atendimento
                description: Canal do suporte
                token: sk_live_xxx
                webhook_secret: whsec_xxx
                subscribed: false
              schema:
                $ref: '#/components/schemas/CanalCriado'
        '400':
          description: O campo name não foi informado.
          content:
            application/json:
              example:
                statusCode: 400
                message: O nome do canal (name) é obrigatório
        '401':
          $ref: '#/components/responses/NaoAutorizado'
        '403':
          $ref: '#/components/responses/AssinaturaInativa'
components:
  schemas:
    CanalCriado:
      type: object
      properties:
        id:
          type: string
          description: ID do canal.
        name:
          type: string
          description: Nome dado ao canal.
        description:
          type:
            - string
            - 'null'
          description: Descrição dada ao canal.
        token:
          type: string
          description: >-
            Token do canal (`sk_live_`), usado nas requisições da API do
            WhatsApp deste canal.
        webhook_secret:
          type: string
          description: Segredo usado na assinatura de todos os webhooks deste canal.
        subscribed:
          type: boolean
          description: Situação da assinatura do canal. Sempre `false` na criação.
  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.
  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.