Recompensas Múltiplas Pré-definidas

Endpoint

Método HTTP: POST

URL : /campaigns

Conteúdo da Requisição

O payload da requisição deve incluir as seguintes propriedades no formato JSON.

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
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.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. Campanhas do tipo Recompensa Única com Múltipla Escolha aplica-se pre-qualified-with-prize-name
settings	object required	Configurações relacionadas às recompensas e limites da campanha.
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 o mesmo 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.

Exemplo de Requisição

curl --request POST \
  --url https://api.minu.biz/v1/campaigns \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data-raw '{
	"startDate": "2025-04-01T00:00:00",
	"endDate": "2025-04-30T23:59:59",
	"experience": {
		"title": "Campanha de Engajamento",
		"sponsor": "Sponsor Name"
	},
	"type": "pre-qualified-with-prize-name",
	"settings": {
		"prizes": ["ifood-credito-r10", "ifood-credito-r20", "ifood-credito-r50"],
		"defaultPrizeList": ["ifood-credito-r20"],
		"rewardLimit": {
			"quantity": 3,
			"period": "daily"
		}
	}
}'

Propriedades de Resposta

Se a requisição for bem-sucedida, a API retornará as seguintes propriedades no formato JSON

Propriedade	Tipo	Descrição
campaignId	string	ID da campanha criada na plataforma.
experienceName	string	Nome da experiencia criada na plataforma.

Exemplo de Resposta

{
	"campaignId": "67e6e637f3be1fa30c7cf10b",
	"experienceName": "minubiz-sponsor-name-campanha-de-engajamento-be369b74-cb09-4b40-96d3-960bcef96c19"
}