Campaigns.Get

post

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

Retorna campanhas de um usuário

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retornos

Success = {true | false}
Mostra se houve erro ou não
ErrorCode = {integer}
Se houve erro, apresenta o código de erro
ErrorText = {text}
Se houver erro, apresenta texto de erro
Campaigns = {array}
Retorna a lista de todas as campanhas
TotalCampaigns = {integer}
Retorna o número total de campanhas

Códigos de Erro

1 - Faltando ID do usuário
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 Campaigns.Get

Comando da API

ResponseFormat

string

required

Defaults to JSON

Formato do retorno

JSONPCallBack

boolean

Envie este parâmetro em caso de cross-domain

CampaignStatus

string

enum

required

Status das campanhas a serem retornadas

OrderField

string

required

Nome do campo para ordenação

OrderType

string

enum

required

Ordenação ascendente ou decrescente

Allowed:

SearchKeyword

string

required

Termo a ser buscado no nome da campanha (campo CampaignName)

RecordsPerRequest

int32

required

Quantas linhas retornar por página

RecordsFrom

int32

required

Começar de (a partir de zero)

RetrieveTags

boolean

Escolha “true” se deseja filtrar a lista de campanhas baseado em filtros específicos