List.Update

post

https://mbiz.mailclick.me/api.php/List.Update

Atualiza informações de 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

Códigos de Erro

1 - Faltou ID da lista
2 - ID da lista inválido
3 - Modo opt-in inválido
4 - Escopo de opt-out inválido
5 - Configuração de notificação de serviço de integração inválida
6 - Configuração inválida
7 - ID do e-mail de confirmação de opt-in não informado
8 - Campos de sincronização precisam ser preenchidos
9 - Email inválido para requisitar processamento
10 - Valor para adicionar à lista de supressão durante opt-out é inválido
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 List.Update

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 a ser atualizada

Name

string

Nome da lista

OptInMode

string

enum

Modo de opt-in da lista

Allowed:

OptInConfirmationEmailID

int32

ID da peça de e-mail que será usada para enviar o e-mail de confirmação de opt-in (requerido se o duplo opt-in estiver ativo)

OptOutScope

string

enum

Escopo do opt-out da lista

Allowed:

OptOutAddToSuppressionList

string

enum

Informe ‘Yes’ para adicionar e-mails descadastrados na lista de supressão

Allowed:

SendServiceIntegrationFailedNotification

boolean

Se setar como ‘true’, um e-mail de notificação será enviado para o dono da lista quando uma integração via web service falhar

SubscriptionConfirmationPendingPageURL

string

URL da página de confirmação de cadastro pendente. Esta página é exibida apenas quando a lista possui duplo opt-in ativado.

SubscriptionConfirmedPageURL

string

URL da página de confirmação de cadastramento

HideInSubscriberArea

boolean

Se for ‘true’, a lista não aparecerá para o contato na sua área de contato

SubscriptionErrorPageURL

string

Opcional. URL da página de erro de cadastro

UnsubscriptionConfirmedPageURL

string

Opcional. URL da página de descadastro confirmado

UnsubscriptionErrorPageURL

string

Opcional. URL da página de erro de descadastro

SendActivityNotification

string

enum

Defaults to false

Opcional. Envia notificação de atividade da lista

Allowed:

OptOutAddToGlobalSuppressionList

string

enum

Defaults to No

Opcional. Adiciona descadastrados à lista de supressão global da conta

Allowed:

OptInSubscribeTo

string

Opcional. IDs das listas para inscrever o contato no opt-in (separados por vírgula)

OptInUnsubscribeFrom

string

Opcional. IDs das listas para descadastrar o contato no opt-in (separados por vírgula)

OptOutSubscribeTo

string

Opcional. IDs das listas para inscrever o contato no opt-out (separados por vírgula)

OptOutUnsubscribeFrom

string

Opcional. IDs das listas para descadastrar o contato no opt-out (separados por vírgula)

ReqByEmailSearchToAddress

string

Opcional. E-mail que recebe os comandos por e-mail. Só é gravado se enviado junto com ReqByEmailSubscriptionCommand e ReqByEmailUnsubscriptionCommand; e-mail inválido gera erro

ReqByEmailSubscriptionCommand

string

Opcional. Palavra de comando para cadastro por e-mail. Só é gravado junto com os outros dois ReqByEmail*

ReqByEmailUnsubscriptionCommand

string

Opcional. Palavra de comando para descadastro por e-mail. Só é gravado junto com os outros dois ReqByEmail*