> For the complete documentation index, see [llms.txt](https://docs.fidelimax.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fidelimax.com.br/premios/cadastro-de-premio.md).

# Cadastro de Prêmio

## CadastrarPremio

<mark style="color:green;">`POST`</mark> `https://api.fidelimax.com.br/api/Integracao/CadastrarPremio`

Exemplo no POSTMAN - <https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-7fc65ea2-b5f5-4c6f-859e-4ce125072aa1>

#### Headers

| Name                                           | Type   | Description                                                                                                    |
| ---------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------- |
| AuthToken<mark style="color:red;">\*</mark>    | string | Token de integração que está na sua plataforma de controle em Integrações > API da Fidelimax > Quero Integrar. |
| Content-Type<mark style="color:red;">\*</mark> | String | application/json                                                                                               |

#### Request Body

| Name                                              | Type    | Description                                                                                                                                                        |
| ------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| nome<mark style="color:red;">\*</mark>            | string  | Nome do prêmio, com até 200 caracteres                                                                                                                             |
| descricao                                         | string  | Descrição detalhada do prêmio, com até 2000 caracteres                                                                                                             |
| pontos\_debitar<mark style="color:red;">\*</mark> | integer | Quantidade de pontos a serem debitados quando o cliente resgatar o prêmio, esse valor deve ser maior que 0                                                         |
| ilimitado<mark style="color:red;">\*</mark>       | boolean | Quando true indica que o estoque é ilimitado, quando false deve ser passado a quantidade em estoque                                                                |
| codigo\_externo<mark style="color:red;">\*</mark> | string  | Identificador único vinculado ao prêmio, ele é utilizado quando é necessário resgatar um prêmio via API e ao incluir vouchers por API, com no máximo 80 caracteres |
| quantidade                                        | integer | Quantidade em estoque disponivel para resgate                                                                                                                      |
| foto\_url                                         | string  | URL da foto do prêmio para ser exibido na plataforma do seu cliente e nos endpoints da API                                                                         |
| inativo                                           | boolean | Quando true, o prêmio não aparecerá para o consumidor, mas pela API será possível resgatar este prêmio.                                                            |

{% tabs %}
{% tab title="200 CodigoResposta - Identificação numérica da resposta
MensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OK" %}

```
{  
  "CodigoResposta": 100,
  "MensagemErro": null
}
```

{% endtab %}
{% endtabs %}