Segments.Get

Carrega todos os segmentos de uma lista.

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

  • 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}
    Se houve erro, apresenta o texto do erro

  • TotalSegmentCount = {integer}
    Total de segmentos da lista

  • Segments = {array}
    Segmentos retornados

Códigos de Erro

  • 1 - Faltou o ID da lista (SubscriberListID)
  • 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 Segments.Get

Comando da API

string
required
Defaults to JSON

Formato do retorno

boolean

Envie este parâmetro em caso de cross-domain

integer
required

ID da lista para retornar os segmentos

string

Campo de ordenação (opcional)

string
enum

Tipo de ordenação (opcional)

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