Subscriber.Subscribe

Cadastra um e-mail em uma ou mais listas. Caso o parâmetro UpdateIfExists seja utilizado realiza uma operação de Upsert.

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.

  • SubscriberID = {integer}
    ID do contato cadastrado será retornado se o cadastramento funcionar.

  • RedirectURL = {string}
    URL para redirecionar após o processo

  • ErrorCode = {integer}
    Se houve erro, apresenta o código de erro

  • ErrorCustomFieldID = {integer}
    Se houver erro com um dos campos personalizados informados, o ID
    do campo personalizado será informado

  • ErrorCustomFieldTitle = {integer}
    Se houver erro com um dos campos personalizados, o nome deste(s)
    campo(s) será informado

  • ErrorCustomFieldDescription = {integer}
    Se houver erro com um dos campos personalizados, a descrição do
    erro será informada

Códigos de erro

  • 1 - Faltou o ID da Lista
  • 2 - Faltou o e-mail
  • 3 - Faltou o IP de origem
  • 4 - ID da lista inválido
  • 5 - E-mail inválido
  • 6 - Um dos campos personalizados está vazio. O ID do e nome do campo
    é informado como um parâmetro adicional de retorno
  • 7 - Um dos valores informados para o campo personalizado já existe na
    lista. Por favor insira um valor diferente. O ID e nome do campo será
    informado como um parâmetro adicional de retorno
  • 8 - Um dos valores para o(s) campo(s) personalizado(s) falhou na
    validação de dados. O ID e nome do campo em questão será
    informado como um parâmetro adicional.
  • 9 - O e-mail já existe na lista
  • 10 - Ocorreu um erro desconhecido
  • 11 - Informação inválida para o usuário
  • 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 Subscriber.Subscribe

Comando da API

string
required
Defaults to JSON

Formato do retorno

boolean

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

int32
required

ID da lista a cadastrar o e-mail

string
required

E-mail a ser cadastrado

string
required

Informação adicional sobre o contato. Substitua o "1" pelo ID do campo personalizado.

string
required

Endereço IP da requisição de origem do novo contato

boolean
Defaults to false

Enviar true, caso queira atualizar o subscribe

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