benefícioseditar plano
PATCH
/v1/benefit-plans/:planIdpermissão: manage_employeesEditar plano
Muda só o que vier no corpo. Mudar o valor do plano não reescreve as adesões que já têm valor próprio.
parâmetros do caminho
- planIduuidobrigatório
- Id do plano.
corpo da requisição
- namestringopcional
- Nome do plano, até 120 caracteres.
- categoryhealth_plan | dental_plan | life_insurance | meal_voucher | food_voucher | transport_voucher | childcare | education | gym | fuel | otheropcional
- Categoria do benefício.
- providerstring | nullopcional
- Operadora ou fornecedor.
- employerCostnumberopcional
- Custo mensal do empregador.
- employeeCostnumberopcional
- Desconto mensal do funcionário.
- notesstring | nullopcional
- Observação livre, até 1000 caracteres.
erros deste endpoint
- 401not_authenticatedA chave não veio, não existe mais ou foi revogada.
- 403not_allowedA chave não tem manage_employees.
- 404not_foundO recurso não existe nesta organização.
- 409benefit_plan_name_takenJá existe um plano com esse nome nesta organização.
- 422invalid_inputUm campo não passou na validação; fields aponta qual.