Subscribers.Get

post

https://mbiz.mailclick.me/api.php/Subscribers.Get

Busca os contatos de uma lista.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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}
Retorna informações sobre o erro.
Subscribers = {array}
Retorna as informações do contato
TotalSubscribers = {integer}
Retorna o número total de contatos

Códigos de erro

1 - Faltou o ID da Lista
2 - ID do segmento não informado
99998 - Falha de autenticação ou sessão expirada
99999 - Sem privilégios suficientes

Query Params

APIKey

string

required

Chave de autenticação

Command

string

required

Defaults to Subscribers.Get

Comando da API

ResponseFormat

string

required

Defaults to JSON

Formato do retorno

JSONPCallBack

boolean

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

OrderField

string

Nome do campo para ordenação

OrderType

string

enum

Ordenação ascendente ou decrescente

Allowed:

RecordsFrom

int32

Começar de (começa de zero)

RecordsPerRequest

int32

Quantas linhas retornar por página

SearchField

string

Campo da lista a ser buscado. Deixe em branco para desabilitar a busca

SearchKeyword

string

O termo a ser buscado em uma lista. Deixe em branco para desabilitar a busca.

SubscriberListID

int32

required

ID da lista

SubscriberSegment

string

required

ID do segmento desejado ou um dos seguintes filtros: Suppressed, Unsubscribed, Soft bounced, Hard bounced, Opt-in pending, Active.

UpdatedDate

string

Data a partir DE, que deseja verificar as atualizações. Deve ser informada no formato AAAA-MM-DD.

Fields

string

Opcional. Lista de colunas a retornar, separadas por vírgula (projeção). Coluna inválida retorna ErrorCode 5. É ignorado quando SubscriberSegment = Suppressed