Subscribers.Import

Importa os dados dos contatos informados para uma lista de contatos.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retornos

  • Success = {true | false}
    Mostra se houve erro ou não.

  • ErrorCode = {integer | array de integers}
    Se houve erro, apresenta o código de erro. Quando um parâmetro obrigatório não é enviado, o retorno é um array (ex.: [1]); nos demais erros é um integer.

  • ErrorText = {text}
    Se houve erro, apresenta o texto do erro

  • ImportID = {integer}
    ID dos dados de importação

  • ImportFields = {string}
    Lista dos campos incluídos nos dados de importação (passo 1)

  • AllowedMaxSize = {integer}
    Tamanho máximo permitido para o arquivo a ser importado. É
    retornado em caso de ocorrer o erro #18 (passo 1)

  • TotalData = {integer}
    Número total de linhas nos dados importados (passo 2)

  • TotalImported = {integer}
    Número de e-mails importados (passo 2)

  • TotalDuplicates = {integer}
    Número de e-mails que já existem e foram ignorados (passo 2)

  • TotalFailed = {integer}
    Número de e-mails que tiveram importação com falha (passo 2)

  • TotalLimited = {integer}
    Linhas descartadas por estourar o limite de contatos da conta (passo 2)

  • TotalRejected = {integer}
    E-mails rejeitados pelo MailScore como inválidos ou suspeitos, quando UseMailScore está ativo (passo 2)

  • TotalCorrected = {integer}
    E-mails importados com sucesso cujo endereço foi corrigido automaticamente (passo 2)

Códigos de erro

  • 1 - Tipo de importação não selecionado
  • 2 - Dados de importação não fornecidos
  • 3 - Passo de importação inválido
  • 4 - ID da lista é inválido
  • 5 - Dados do CSV não estão em um formato suportado
  • 6 - Processo de importação já concluído
  • 7 - E-mail mapeado com múltiplos campos
  • 8 - E-mail não mapeado com nenhum campo
  • 9 - Faltou arquivo enviado
  • 13 - Arquivo não existe
  • 17 - Tipo de importação não suportado
  • 18 - Arquivo enviado excede o limite de tamanho máximo permitido.
  • 99998 - Falha de autenticação ou sessão expirada
  • 99999 - Sem privilégios suficientes
Query Params
string
required

Chave de Autenticação

string
required
Defaults to Subscribers.Import

Comando da API

string
required
Defaults to JSON

Formato do retorno

boolean

Envie este parâmetro em caso de cross-domain.

int32

ID da lista

string
enum

1 para informar dados a serem importados, 2 para mapeamento de campos

Allowed:
int32

ID do processo de importação (passo 2)

string
required

Tipo de importação (Copy | File | MySQL) (passo 1)

string

Conteúdo do arquivo CSV (passo 1)

string

Nome do arquivo enviado (passo 1)

string

Informe o caractere terminador dos campos no caso de importação a partir de arquivo CSV.

string

Informe o caractere de delimitação dos campos no caso de importação a partir de arquivo CSV.

boolean

Define se a importação deve ser feita para a Lista de Supressão Global ou não (passo 1)

boolean

Define se a importação deve ser feita para a Lista de Supressão ou não (passo 1)

string

Campos mapeados (passo 2)

boolean
Defaults to true

Opcional. Atualiza contatos que já existem na lista. Padrão: true

boolean
Defaults to false

Opcional. Envia e-mail de confirmação de opt-in aos importados. Padrão: false

boolean
Defaults to false

Opcional. Dispara os behaviors da lista para os importados. Padrão: false

boolean

Opcional. Aplica a validação MailScore nos e-mails importados

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!