Criar Campanhas
Campanhas incentivam interações do consumidor e recompensam comportamentos específicos, promovendo maior conexão entre consumidores e marcas.
Campanha Disponíveis
Recompensa Única Pré-definida sem telefonia O consumidor recebe uma única recompensa, definida pelo cliente corporativo.
Recompensa Única Pré-definida de telefonia O consumidor recebe, como recompensa, bônus de telefonia.
Recompensa Única Múltipla Escolha O cliente corporativo disponibiliza até cinco opções de recompensa, e o consumidor pode escolher apenas uma.
Recompensas Multi-bônus O consumidor recebe um valor definido pelo cliente corporativo e pode escolher recompensas dentro do valor disponível.
Recompensas Múltiplas Pré-definidas O consumidor recebe várias recompensas pré-definidas pelo cliente corporativo.
Conteúdo da Requisição
Consulte o payload completo, com todos os campos disponíveis e suas respectivas configurações.
O payload da requisição deve incluir as seguintes propriedades no formato JSON.
WARNING
Entre em contato com o time técnico para mais detalhes e casos de uso.
| Propriedade | Tipo | Descrição |
|---|---|---|
startDate | string required | Data início da campanha. Ex 2022-09-01T00:00:00 |
endDate | string required | Data término da campanha. Ex 2022-09-01T00:00:00 |
description | string | Texto breve que descreve os objetivos ou informações gerais sobre a campanha. |
expectedReach | integer | Numero estimado de Consumidores que a campanha deve alcançar. |
experience | object required | Informações básicas da campanha. |
experience.title | string required | Título da campanha. |
experience.sponsor | string required | Nome da marca ou Cliente corporativo patrocinador da campanha. |
experience.daysToQualify | integer | Define o numero de dias para a entrega de uma recompensa padrão caso o Consumidor não faça uma escolha. |
experience.multiDeliveryEngine | boolean | Indica se há fallback para entrega de vouchers de telefonia. Default true |
experience.backgroundColor | string | Indica cor de fundo que deverá ser aplicada ao e-mail e tela de Escolhas de recompensas. Default #003033 |
experience.appreciationMessage | string maxLength:70 | Indica mensagem de boas vindas exibida para o usuário na tela de Escolhas de recompensas. Máximo 70 caracteres. |
experience.logoId | string | ID gerado a partir da rota de upload de imagens. Obtido de POST /upload/logo. |
experience.bannerId | string | ID gerado a partir da rota de upload de imagens. Obtido de POST /upload/banner. |
type | string required | Mecânica de recompensa aplicada na campanha. pre-qualified-without-questions pre-qualified-bonus multiple-choice pre-qualified-with-prize-name |
settings | object required | Configurações relacionadas às recompensas e limites da campanha. |
settings.preQualifiedPrize | string | Nome da recompensa principal, definida para ser entregue durante a campanha. |
settings.defaultPrizeList | array required | Recompensas predefinidas que serão ofertadas caso o Consumidor não escolha. |
settings.prizes | array required | Lista de recompensas disponíveis para escolha |
settings.rewardLimit | object required | Configurações que definem os limites de entrega das recompensas. |
settings.rewardLimit.quantity | integer required | Número máximo de recompensas que podem ser entregues para um consumidor durante o período definido. |
settings.rewardLimit.period | string required | Período de tempo em que o limite será aplicado. Valores válidos once, daily, weekly, monthly . |
INFO
Para instruções sobre envio de imagens, formatos compatíveis e exemplos de requisição, consulte a seção Upload de Imagens.