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

# Criar Configuração SFTP da Campanha

> Configurar integração SFTP para uma campanha

# Criar Configuração SFTP da Campanha

Configura a integração SFTP para uma campanha. A configuração é criada no estado `disabled` — teste a conexão com sucesso antes de habilitar.

## Endpoint

```
POST /api/v1/campaigns/{campaign_id}/sftp
```

## Parâmetros de caminho

<ParamField path="campaign_id" type="string" required>UUID da campanha.</ParamField>

## Cabeçalhos da requisição

<ParamField header="Authorization" type="string" required>
  Token Bearer. Formato: `Bearer talq_your_environment_token_here`
</ParamField>

<ParamField header="Content-Type" type="string" required>
  Deve ser definido como `application/json`
</ParamField>

## Corpo da requisição

<ParamField body="host" type="string" required>Hostname do servidor SFTP.</ParamField>
<ParamField body="port" type="integer">Porta SFTP. Faixa: `1`–`65535`. Padrão: `22`.</ParamField>
<ParamField body="username" type="string" required>Usuário SFTP.</ParamField>
<ParamField body="auth_type" type="string" required>Método de autenticação. Opções: `password`, `private_key`.</ParamField>
<ParamField body="password" type="string">Obrigatório quando `auth_type` é `password`.</ParamField>
<ParamField body="private_key" type="string">Obrigatório quando `auth_type` é `private_key`. Chave privada codificada em PEM.</ParamField>
<ParamField body="private_key_passphrase" type="string">Passphrase opcional para a chave privada.</ParamField>
<ParamField body="import_path" type="string">Diretório remoto a varrer para importações de lista de contatos (ex: `/inbox`).</ParamField>
<ParamField body="export_path" type="string">Diretório remoto onde arquivos de resultado de chamadas são enviados (ex: `/outbox`).</ParamField>
<ParamField body="import_schedule" type="string">Agenda de importação automática. Opções: `manual`, `hourly`, `daily`. Padrão: `manual`.</ParamField>

## Exemplos

<RequestExample>
  ```bash theme={null}
  curl -X POST "https://app.talkover.ai/api/v1/campaigns/campaign-uuid/sftp" \
    -H "Authorization: Bearer talq_your_environment_token_here" \
    -H "Content-Type: application/json" \
    -d '{
      "host": "sftp.example.com",
      "port": 22,
      "username": "campaigns_user",
      "auth_type": "password",
      "password": "secret",
      "import_path": "/inbox",
      "export_path": "/outbox",
      "import_schedule": "daily"
    }'
  ```
</RequestExample>

## Resposta

<ResponseExample>
  ```json theme={null}
  {
    "success": true,
    "data": {
      "id": "sftp-config-uuid-1",
      "campaign_id": "campaign-uuid",
      "host": "sftp.example.com",
      "is_enabled": false,
      "created_at": "2024-01-15T16:00:00Z"
    }
  }
  ```
</ResponseExample>
