Recompensa Única

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.

Propriedade	Tipo	Descrição
experience	string required	Nome da experiência na plataforma. Ex minubiz-experience-name-cb4e492d-c28c
data	object required	Objeto contendo dados da recompensa enviada
data.mobile	string length:11	Telefone do consumidor recompensado. Ex 11999999999
data.email	string	E-mail do consumidor recompensado. Ex arthur.dent@hitchhiker.com
data.order_id	string required unique	Identificador único do pedido gerado pelo Cliente Corporativo.
data.reward_value	integer	Valor total da recompensa enviada ao consumidor recompensado. Obrigatório para campanhas do tipo Recompensa Única de Telefonia.
data.prizes	array	Coleção de recompensas a serem entregues. Somente em campanhas do tipo Recompensas Múltiplas Pré Definida.
data.prizes.name	string	Identificador da recompensa utilizado na plataforma Minu.biz.
data.prizes.quantity	integer	Quantidade de prêmios a serem entregues.
data.reward_value	integer	Valor disponível para resgate de recompensas

Exemplo de Requisição

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": "foo_123"
  }
}'

Propriedades de Resposta

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

Propriedade	Tipo	Descrição
_id	string	ID do registro criado na plataforma.
requestId	string	ID do pedido de recompensa criado na plataforma.
experience	string	Nome da experiência na plataforma. Ex minubiz-experience-name-cb4e492d-c28c

Exemplo de Resposta

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