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

# Implantar um fluxo de conversação

> Este endpoint permite implantar uma conversa para uma lista de usuários definidos pelo seu número de telefone e código de país. Também permite agendar implantações para uma data futura.

<Warning>
  Lembre-se que para usar este endpoint, você deve ter obtido sua chave de API na seção de **Desenvolvedores** da plataforma Treble.
</Warning>

## Selecionar qual número implanta (empresas multicanal)

Para empresas multicanal, você pode selecionar de qual celular o usuário será implantado usando `user_session_keys`. Se você quiser que o primeiro número faça a implantação, basta adicionar a chave `deployment_squad` e o valor correspondente será `DS_[CELLPHONE]`. Você pode adicionar vários *deployment squads* para que vários números possam implantar.

```json theme={null}
"user_session_keys": [
  {
    "key": "deployment_squad",
    "value": "DS_[CELLPHONE]"
  }
]
```


## OpenAPI

````yaml open-api-files/treble-api-pt.json POST /deployment/api/poll/{poll_id}
openapi: 3.0.1
info:
  title: API do Treble Poll
  description: Documentação para o endpoint de implantação de polls no Treble
  version: 1.0.0
servers:
  - url: https://main.treble.ai
    description: Servidor principal do Treble
  - url: https://seudominio.com
    description: >-
      Servidor de exemplo para implementar os webhooks. Isso representa SEU
      servidor onde você deve implementar os endpoints que o Treble chamará.
security: []
tags:
  - name: Webhooks
    description: >-
      Endpoints que o Treble chamará no seu servidor. Estes não são endpoints
      reais que você possa chamar, mas uma representação dos webhooks que o
      Treble invocará no seu sistema.
paths:
  /deployment/api/poll/{poll_id}:
    post:
      summary: Implantar um poll para usuários específicos
      description: >-
        Este endpoint permite implantar uma conversa para uma lista de usuários
        definidos pelo seu número de telefone e código de país. Também permite
        agendar implantações para uma data futura.
      parameters:
        - name: poll_id
          in: path
          required: true
          description: ID do poll que você deseja implantar
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          description: >-
            Chave API de autorização. Pode ser obtida em
            https://app.treble.ai/en/dashboard/settings
          schema:
            type: string
          example: API_KEY
        - name: Content-Type
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: Informações dos usuários para os quais o poll será implantado
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - users
              properties:
                users:
                  type: array
                  description: Lista de usuários para os quais o poll será implantado
                  items:
                    type: object
                    required:
                      - cellphone
                      - country_code
                      - user_session_keys
                    properties:
                      cellphone:
                        type: string
                        description: >-
                          Número de telefone do usuário sem o código do país
                          (por exemplo: '3051234567')
                      country_code:
                        type: string
                        description: 'Código do país com o símbolo + (por exemplo: ''+57'')'
                      user_session_keys:
                        type: array
                        description: >-
                          Variáveis que podem ser substituídas nos textos das
                          perguntas ou entregues quando um webhook é chamado.
                          Para empresas multicanal, pode incluir a chave
                          'deployment_squad' para selecionar qual número de
                          telefone realizará a implantação.
                        items:
                          type: object
                          required:
                            - key
                            - value
                          properties:
                            key:
                              type: string
                              description: >-
                                Nome da variável. Valores especiais incluem
                                'deployment_squad' para selecionar qual número
                                de telefone realizará a implantação em empresas
                                multicanal.
                            value:
                              type: string
                              description: >-
                                Valor da variável. Para 'deployment_squad', o
                                valor deve ser 'DS_[CELLPHONE]'.
                      deployment_eta:
                        type: integer
                        description: >-
                          Timestamp UNIX UTC para agendar a implantação para uma
                          data futura (opcional). Exemplo: 1615823201 (15 de
                          março de 2021, 3:46:41 PM UTC)
            examples:
              Exemplo básico:
                value:
                  users:
                    - cellphone: '3051234567'
                      country_code: '+57'
                      user_session_keys:
                        - key: name
                          value: João
                        - key: TransID
                          value: '12345'
                        - key: schoolname
                          value: Redschool
              Exemplo com deployment_eta:
                value:
                  users:
                    - cellphone: '3051234567'
                      country_code: '+57'
                      user_session_keys:
                        - key: name
                          value: João
                      deployment_eta: 1615823201
              Exemplo com deployment_squad:
                value:
                  users:
                    - cellphone: '3051234567'
                      country_code: '+57'
                      user_session_keys:
                        - key: name
                          value: João
                        - key: deployment_squad
                          value: DS_[CELLPHONE]
      responses:
        '200':
          description: O poll foi implantado corretamente
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Mensagem de confirmação
                  id:
                    type: string
                    description: ID da implantação
                  batch_id:
                    type: string
                    description: ID do lote de implantação
                  new_last_scheduleded_deployment:
                    type: string
                    format: date-time
                    description: Data e hora da última implantação programada
                  conversations_id:
                    type: array
                    items:
                      type: string
                    description: Lista de IDs das conversas criadas
              example:
                message: The poll was deployed
                id: 5f8d7e6a5f8d7e6a5f8d7e6a
                batch_id: 5f8d7e6a5f8d7e6a5f8d7e6b
                new_last_scheduleded_deployment: '2021-03-15T15:46:41Z'
                conversations_id:
                  - 5f8d7e6a5f8d7e6a5f8d7e6c
        '400':
          description: Erro na solicitação
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Código de erro
                  message:
                    type: string
                    description: Descrição do erro
        '401':
          description: Não autorizado. Chave API inválida ou ausente.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Código de erro
                  message:
                    type: string
                    description: Descrição do erro
        '404':
          description: Poll não encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Código de erro
                  message:
                    type: string
                    description: Descrição do erro

````