Skip to content

Recompensas Múltiplas Pré-definidas

Endpoint

Método HTTP: POST

URL : /requests

Conteúdo da Requisição

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

PropriedadeTipoDescrição
experiencestring requiredNome da experiência na plataforma. Ex minubiz-experience-name-cb4e492d-c28c
dataobject requiredObjeto contendo dados da recompensa enviada
data.mobilestring length:11Telefone do consumidor recompensado.
Ex 11999999999
data.emailstringE-mail do consumidor recompensado.
Ex arthur.dent@hitchhiker.com
data.order_idstring required uniqueIdentificador único do pedido gerado pelo Cliente Corporativo.
data.reward_valueintegerValor total da recompensa enviada ao consumidor recompensado. Obrigatório para campanhas do tipo Recompensa Única de Telefonia.
data.prizesarrayColeção de recompensas a serem entregues. Somente em campanhas do tipo Recompensas Múltiplas Pré Definida.
data.prizes.namestringIdentificador da recompensa utilizado na plataforma Minu.biz.
data.prizes.quantityintegerQuantidade de prêmios a serem entregues.
data.reward_valueintegerValor disponível para resgate de recompensas

Exemplo de Requisição

sh
curl --request POST \
  --url https://api.minu.biz/v1/requests \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data-raw '{
  "experience": "minubiz-experience-name-cb4e492d-c28c",
  "data": {
    "mobile": "11999999999",
    "email": "arthur.dent@hitchhiker.com",
    "order_id": "unique_123",
    "prizes": [
      {
        "name": "ifood-credito-r10",
        "quantity": 1
      },
      {
        "name": "bob-s-sundae",
        "quantity": 1
      }
    ]
  },
}'

Propriedades de Resposta

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

PropriedadeTipoDescrição
_idstringID do registro criado na plataforma.
requestIdstringID do pedido de recompensa criado na plataforma.
experiencestringNome da experiência na plataforma. Ex minubiz-experience-name-cb4e492d-c28c

Exemplo de Resposta

sh
{
  "_id": "62e8274f64abd3c501af74e3",
  "requestId": "62e8274f64abd3c501af74e3",
  "experience": "minubiz-experience-name-097b1d5a-2f9e-453e-a735-bfeb142af94f"
}

Direitos reservados © 2021-2025 Minu