Subscriber.Subscribe

🚧

Atenção

Toda resposta desta API é devolvida com HTTP 200, inclusive as recusas.

O status HTTP não indica falha. Verifique sempre o campo Success do corpo da resposta: uma integração que checa apenas o status HTTP lê uma recusa como sucesso e descarta o contato sem registrar erro.

Retornos

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

• SubscriberID = {integer}
  ID do contato cadastrado, retornado quando o cadastramento funciona

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

• Subscriber = {object}
  Registro completo do contato cadastrado

• 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 = {string | array de strings}
  Se houve erro, descreve a causa em texto. Acompanha o formato do ErrorCode: array de descrições quando falta parâmetro obrigatório, uma por parâmetro ausente; string nos demais erros.

• ErrorCustomFieldID = {integer}
  Nos erros 6, 7 e 8: ID do campo personalizado que causou o erro

• ErrorCustomFieldTitle = {text}
  Nos erros 6, 7 e 8: nome do campo personalizado que causou o erro

• ErrorCustomFieldDescription = {text}
  No erro 8: descrição da falha de validação do campo personalizado

Contato já cadastrado

Reenviar um e-mail que já existe na lista não é erro. A resposta é Success: true com ErrorCode: 0 e o SubscriberID do registro existente — a operação é idempotente e nenhum contato novo é criado.

Nesse caso o SubscriberID volta como string; no cadastramento de um contato novo volta como integer. Integrações com desserialização tipada precisam aceitar os dois formatos.

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 campo personalizado obrigatório está vazio (ver ErrorCustomFieldID e ErrorCustomFieldTitle)
• 7 - Valor de campo personalizado único já existe na lista (ver ErrorCustomFieldID e ErrorCustomFieldTitle)
• 8 - Valor de campo personalizado falhou na validação (ver ErrorCustomFieldDescription)
• 9 - Não ocorre neste endpoint. E-mail já cadastrado retorna sucesso, não erro (ver Contato já cadastrado acima)
• 10 - O cadastramento não pôde ser concluído. Consulte o ErrorText, que distingue as causas — entre elas a conta ter atingido o limite de contatos do plano
• 11 - Conta dona da lista indisponível (inexistente ou desabilitada)
• 99998 - Falha de autenticação ou sessão expirada
• 99999 - Sem privilégios suficientes