Importar

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

[block:callout] { "type": "info", "body": "Este endpoint é processado assincronamente.", "title": "Processamento Assíncrono" } [/block]

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 Params
string
enum
required

Tipo da importação:

  • customers Clientes
  • customer_subscriptions Assinaturas
  • bank_billets Boletos
  • installments Carnês
Allowed:
Body Params

Parâmetros para criação de uma importação.

file
required

Arquivo para importação.

Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

Language
Credentials
Bearer
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json