Campaign.Update

Atualiza informações da campanha

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

Códigos de Erro

  • 1 - Faltando ID da campanha
  • 2 - ID da campanha inválido
  • 3 - Valor inválido para status da campanha
  • 4 - ID do email (conteúdo) inválido
  • 5 - Valor inválido para o tipo de agendamento
  • 6 - Faltou data de envio
  • 7 - Faltou horário de envio
  • 8 - Dia do mês ou dia da semana precisa ser informado para
    agendamento recorrentes
  • 9 - Meses precisam ser informados para agendamento recorrente
  • 10 - Horas precisam ser informadas para agendamento recorrente
  • 11 - Minutos precisam ser informados para agendamento recorrente
  • 12 - Número de repetições precisa ser informado para agendamento
    recorrente
  • 13 - Faltou o fuso-horário (timezone)
  • 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 Campaign.Update

Comando da API

string
required
Defaults to JSON

Formato do retorno

boolean

Envie este parâmetro em caso de cross-domain

int32
required

ID da campanha a ser atualizada

string
enum

Define o status da campanha

string

Nome da campanha

int32

O conteúdo (peça) de uma campanha (email ID)

string
enum

Tipo de agendamento

Allowed:
date

Data para enviar a campanha (YYYY-MM-DD)

string

Hora para enviar a campanha (HH: MM: SS)

string

Fuso-horário da data agendada

string

(Agendamento recorrente) separados com vírgula (,). Insira “0” para todos os dias {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7}

string

(Agendamento recorrente) separados com vírgula (,). Insira “0” para todos os dias {0 | 1 | 2 | 3 | 4 | 5 | ... | 31}

string

(Agendamento recorrente) separados com vírgula (,).Insira “0” para todos os meses {0 | 1 | 2 | ... | 12}

string

(Agendamento recorrente) separados com vírgula (,) {0 | 1 | 2 | ... | 23}

string

(Agendamento recorrente) separados com vírgula (,) {0 | 1 | 2 | ... | 59}

int32

(Agendamento recorrente) número de vezes para repetir o envio (insira 0 para ilimitado)

string

Explicação do usuário sobre campanha se ela estiver aguardando aprovação

string

Domínios para rastrear com Google Analytics (separe domínios com quebra de linha (\n))

string

Listas e/ou segmentos de destinatários. Cada segmento e lista é separado por vírgula. Formato: ListID: SegmentID,ListID: SegmentID Exemplo: 3: 0,3: 2

string
enum

Opcional. Publica a campanha no feed RSS

Allowed:
string

Opcional. Data/hora em que a campanha foi pausada (YYYY-MM-DD HH:MM:SS)

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