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 houve erro, apresenta o texto do erro
Campaigns = {array}
Campanhas retornadas
TotalCampaigns = {integer}
Número total de campanhas que atendem ao filtro

Códigos de Erro

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

Status das campanhas a serem retornadas

OrderField

string

Nome do campo para ordenação

OrderType

string

enum

Ordenação ascendente ou decrescente

Allowed:

SearchKeyword

string

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

RecordsPerRequest

int32

Quantas linhas retornar por página

RecordsFrom

int32

Começar de (a partir de zero)

RetrieveTags

boolean

Opcional. Se true, retorna as tags de cada campanha no payload. Não filtra — para filtrar por tag use o parâmetro Tags