Atualizar benefício

PUT /api/v1/valepix/benefits/{benefit_id}

Atualiza uma configuração de benefício da integração autorizada.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json
Content-Type: application/json

Path params

Parâmetro	Tipo	Obrigatório	Descrição
benefit_id	string	Sim	Identificador do benefício retornado pela API

Body

Envie a configuração atualizada do benefício. Quando items for enviado, a lista substitui os itens anteriores; inclua todos os itens que devem permanecer ativos no benefício.

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do benefício
description	string	Não	Descrição do benefício
coparticipation_percentage	number	Sim	Percentual de coparticipação
items	array	Sim	Lista de produtos e valores mensais do benefício

Objeto de items:

Campo	Tipo	Obrigatório	Descrição
product_id	string	Sim	Campo id retornado por Listar produtos
monthly_amount	number	Sim	Valor mensal do item em centavos

Use o payload completo acima para substituir a configuração do benefício. O benefit_id vem da URL.

Exemplo curl

curl --request PUT \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --url "https://routes.valepix.com.br/api/v1/valepix/benefits/$BENEFIT_ID" \
  --data '{
    "name": "Benefício Flexível",
    "description": "Configuração atualizada para colaboradores elegíveis",
    "coparticipation_percentage": 0,
    "items": [
      {
        "product_id": "00000000-0000-4000-8000-000000000201",
        "monthly_amount": 60000
      }
    ]
  }'

Response

{
  "success": "success",
  "data": {
    "success": true
  }
}

Erros comuns

HTTP	Quando acontece	Ação recomendada
400	Payload inválido, benefício duplicado, item ausente, produto inválido ou item duplicado	Corrigir dados enviados
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
404	Benefício não encontrado	Conferir benefit_id
500	Erro interno temporário	Tentar novamente com backoff