Email.Update

Atualiza o conteúdo/configuração de um e-mail existente do usuário autenticado.

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.

Códigos de Erro

  • 3 - E-mail não encontrado (ou não pertence ao usuário)
  • 4 - Mode inválido (aceita apenas Empty, Template ou Import)
  • 6 - FromEmail em formato inválido
  • 7 - ReplyToEmail em formato inválido
  • 8 - Não foi possível determinar o ContentType (HTML e texto simples ambos vazios, com Mode != Import)
  • 9/10 - ValidateScope ausente ou fora de OptIn|Campaign|AutoResponder
  • 11 - Falta %Link:Unsubscribe% no HTML (ValidateScope=Campaign ou AutoResponder, quando exigido pela configuração do grupo do usuário)
  • 12 - Falta %Link:Unsubscribe% no texto simples (mesma condição acima)
  • 13 - Falta %Link:Confirm% no HTML (ValidateScope=OptIn)
  • 14 - Falta %Link:Confirm% no texto simples (ValidateScope=OptIn)
  • 15 - Falta %Link:Reject% no HTML (ValidateScope=OptIn, quando exigido pela configuração do grupo)
  • 16 - Falta %Link:Reject% no texto simples (mesma condição acima)
  • 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 Email.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 do e-mail a atualizar

string
enum
required
Defaults to Campaign

Escopo de validação de conteúdo: Campaign (exige link de descadastramento %Link:Unsubscribe% no conteúdo), OptIn (exige link de confirmação de aceite %Link:Confirm%, e %Link:Reject% quando aplicável) ou AutoResponder (mesma exigência de Campaign)

Allowed:
string

Nome interno do e-mail

string

Assunto do e-mail

string

Nome do remetente

string

E-mail do remetente

string

Nome para resposta

string

E-mail para resposta

string
enum

Empty (HTML direto), Template ou Import. Se Template, RelTemplateID passa a ser obrigatório. Se Import, usa FetchURL/FetchPlainURL

Allowed:
string

Obrigatório para montar o conteúdo quando Mode=Import

string

Versão em texto simples, usada quando Mode=Import

integer

Obrigatório quando Mode=Template

string

Corpo HTML do e-mail

string

Corpo em texto simples

string

Modo de incorporação de imagens

integer
enum

Identificador do editor de origem do conteúdo. ID 1 para o editor classico (HTML) e ID 3 para editor visual

Allowed:
string

HTML bruto salvo pelo editor Stripo

string

StripoCSS

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