CustomField.Create

post

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

Cria um campo personalizado para uma determinada lista de contatos.

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
CustomFieldID = {integer}
ID do novo campo personalizado

Códigos de Erro

1 - Faltou o ID da lista
2 - Faltou o nome do campo personalizado
3 - Faltou o tipo do campo
4 - Faltou regra de validação
5 - Pré-configuração inválida
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 CustomField.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

PresetName

string

enum

ocê pode criar um novo campo personalizado selecionando uma Pré-Configuração de campo (Exemplo: Gênero, Idade, Emprego, Satisfação, etc)

FieldName

string

Novo do novo campo personalizado

FieldType

string

enum

Tipo do novo campo personalizado

Allowed:

FieldDefaultValue

string

Valor padrão do novo campo personalizado

OptionLabel[n]

string

Título de uma alternativa em caso de múltipla escolha ou dropdown

OptionValue[n]

string

Valor de uma alternativa em caso de múltipla escolha ou dropdown

OptionSelected

array of int32s

Lista dos IDs das alternativas (em caso de múltipla escolha ou dropdown)

OptionSelected

ValidationMethod

string

enum

Método de validação do novo campo personalizado

ValidationRule

string

Regra de validação do campo personalizado

Visibility

string

enum

Se o campo personalizado deve ser exibido na área do contato ou não

Allowed:

IsRequired

string

enum

Se o campo deve ter preenchimento obrigatório ou não

Allowed:

IsUnique

string

enum

Se deve forçar o valor inserido no campo personalizado a ser único ou não

Allowed:

IsGlobal

string

enum

Se este parâmetro for “Yes”, o campo personalizado ficará disponível para todas as listas na conta do usuário

Allowed: