Sign in

v1

latestOpenAPI 3.1.02026-07-249043961.2 KB
Importações

Importar

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.

post/v1/imports/{collection_name}

Path parameters

collection_name'customers' | 'customer_subscriptions' | 'bank_billets' | 'installments' required

Tipo da importação:

  • customers Clientes
  • customer_subscriptions Assinaturas
  • bank_billets Boletos
  • installments Carnês

Headers

User-Agentstring

Informar um e-mail válido para contatos.

X-Idempotency-Keystring

Chave de idempotência para evitar replay de processamento.

Response

Importação criada

idinteger

ID da Importação.

statusstring

Status da importação.

enqueued: Aguardando processamento. [Estado inicial] failed: Processamento não realizado devido a erro. processed: Processamento concluído.

started_atstring date-time nullable

Data/hora de início do processamento da Importação

finished_atstring date-time nullable

Data/hora de fim do processamento da Importação

created_atstring date-time

Data/hora da criação da Importação

updated_atstring date-time

Data/hora da atualização da Importação

created_rowsinteger
enqueued_atstring date-time nullable
processed_atstring date-time nullable
failed_to_create_rowsinteger
failed_to_update_rowsinteger
import_errorsobject nullable
processed_rowsinteger
total_rowsinteger nullable
updated_rowsinteger