Segment.Create

post

https://mbiz.mailclick.me/api.php/Segment.Create

Cria um novo segmento em 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}
Se houve erro, apresenta o texto do erro
SegmentID = {integer}
ID do novo segmento criado

Códigos de Erro

1 - Faltou o ID da lista (SubscriberListID)
2 - Faltou o nome do segmento
3 - Faltou o operador do segmento
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 Segment.Create

Comando da API

ResponseFormat

string

required

Defaults to JSON

Formato do retorno

JSONPCallBack

boolean

Envie este parâmetro em caso de cross-domain

SubscriberListID

int32

required

ID da lista onde será criado o segmento

SegmentName

string

required

Nome do novo segmento

SegmentOperator

string

enum

required

Deve atender a todas as regras ou a qualquer uma das regras

Allowed:

SegmentType

string

Opcional. Tipo do segmento

SegmentRules

string

Opcional. String de regras já formatada. Se enviada, é usada como base e as regras de SegmentRuleField são concatenadas a ela

SegmentRuleField

string

Array das regras: campo avaliado por regra. Ex.: SegmentRuleField[0], SegmentRuleField[1]. Sem este bloco o segmento é criado sem nenhuma regra

SegmentRuleOperator

string

Array das regras: operador de cada regra, na mesma posição de SegmentRuleField

SegmentRuleFilter

string

Array das regras: valor/filtro de cada regra, na mesma posição de SegmentRuleField