---
title: "Importar"
method: POST
path: "/v1/imports/{collection_name}"
tags: ["Importações"]
---

# Importar

`POST /v1/imports/{collection_name}`

## Request

- Base URL: `https://api-sandbox.kobana.com.br`
- URL: `https://api-sandbox.kobana.com.br/v1/imports/{collection_name}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kobana/apis/cobran-as/docs/v1/imports/:collection_name/post.ts> (a function with typed inputs; its response is checked against the schema)

Importa recursos (clientes, assinaturas, boletos ou carnês) através de um arquivo CSV. O processamento é realizado de forma assíncrona.

> **Processamento Assíncrono:** Este endpoint é processado assincronamente.

A Importação é feita assincronamente, ou seja, ao receber a requisição,
a nossa API guarda os parâmetros da requisição e processa a importação em segundo plano.
Após a importação ser processada, os registros serão associados à sua Conta.
Você recebe na resposta desta requisição o ID da Importação criada e pode consultá-lo a qualquer momento.

## Eventos de Webhook

Quando a requisição é realizada, um evento `import.created` é disparado.
O nosso servidor então começa o processamento da importação.
Após o fim do processamento, o evento `import.processed` é disparado.

## Path parameters

- `collection_name` 'customers' | 'customer_subscriptions' | 'bank_billets' | 'installments', required

## Headers

- `User-Agent` string
- `X-Idempotency-Key` string

## Request body `multipart/form-data`

- ImportSend
  - `source` string, binary, required: Arquivo para importação.

## Response `201`

Importação criada

- Import
  - `id` integer: ID da Importação.
  - `status` string: Status da importação. `enqueued`: Aguardando processamento. [Estado inicial] `failed`: Processamento não realizado devido a erro. `processed`: Processamento concluído.
  - `started_at` string, date-time, nullable: Data/hora de início do processamento da Importação
  - `finished_at` string, date-time, nullable: Data/hora de fim do processamento da Importação
  - `created_at` string, date-time: Data/hora da criação da Importação
  - `updated_at` string, date-time: Data/hora da atualização da Importação
  - `created_rows` integer
  - `enqueued_at` string, date-time, nullable
  - `processed_at` string, date-time, nullable
  - `failed_to_create_rows` integer
  - `failed_to_update_rows` integer
  - `import_errors` object, nullable
  - `processed_rows` integer
  - `total_rows` integer, nullable
  - `updated_rows` integer

## Other responses

- `401`: Falha de autenticação. Token inválido

---

[API](https://skmtc.dev/kobana/apis/cobran-as.md) - [All operations](https://skmtc.dev/kobana/apis/cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/kobana/apis/cobran-as/revisions/728c362ec4d7?raw)